pub.oysters.getFeed
A page of the board's feed. Public: no authentication, and the same answer for everybody.
Details · query
| Kind | query |
|---|---|
| Authority | oysters.pub |
| Indexed |
Checks
Validunlimited-stringdefs.main.parameters.properties.cursorNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.parameters.properties.sortNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.output.schema.properties.cursorNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"main": {
"description": "A page of the board's feed. Public: no authentication, and the same answer for everybody.",
"errors": [
{
"description": "An unknown tag, an unknown sort, or a cursor that did not decode.",
"name": "InvalidRequest"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"cursor": {
"description": "Pass to the next call. Absent when there is nothing more.",
"type": "string"
},
"feed": {
"description": "The page, in ranking order.",
"items": {
"ref": "pub.oysters.defs#postView",
"type": "ref"
},
"type": "array"
}
},
"required": [
"feed"
],
"type": "object"
}
},
"parameters": {
"properties": {
"cursor": {
"description": "Opaque. Pass back what the previous page returned; do not construct one.",
"type": "string"
},
"limit": {
"default": 25,
"description": "How many submissions to return.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"sort": {
"default": "hot",
"description": "Ranking to page through. 'hot' is the board's own ranking; 'new' is submission order.",
"knownValues": [
"hot",
"new"
],
"type": "string"
},
"tags": {
"description": "Restrict to submissions carrying any of these tags. OR, not AND. Tags outside the curated vocabulary are an error rather than an empty page, so a typo is visible.",
"items": {
"maxLength": 128,
"type": "string"
},
"maxLength": 10,
"type": "array"
}
},
"type": "params"
},
"type": "query"
}
},
"id": "pub.oysters.getFeed",
"lexicon": 1
}