so.sprk.feed.searchPosts
Find posts matching search criteria, returning views of those posts.
Details · query
| Kind | query |
|---|---|
| Authority | feed.sprk.so |
| Indexed |
Checks
Validunlimited-stringdefs.main.parameters.properties.cursorNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.parameters.properties.qNo 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": "Find posts matching search criteria, returning views of those posts.",
"errors": [
{
"name": "BadQueryString"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"cursor": {
"type": "string"
},
"hitsTotal": {
"description": "Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.",
"type": "integer"
},
"posts": {
"items": {
"ref": "so.sprk.feed.defs#postView",
"type": "ref"
},
"type": "array"
}
},
"required": [
"posts"
],
"type": "object"
}
},
"parameters": {
"properties": {
"cursor": {
"description": "Optional pagination mechanism; may not necessarily allow scrolling through entire result set.",
"type": "string"
},
"limit": {
"default": 25,
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"q": {
"description": "Search query string; to match against post descriptions and such.",
"type": "string"
},
"sort": {
"default": "latest",
"description": "Specifies the ranking order of results.",
"knownValues": [
"top",
"latest"
],
"type": "string"
}
},
"required": [
"q"
],
"type": "params"
},
"type": "query"
}
},
"id": "so.sprk.feed.searchPosts",
"lexicon": 1
}