Backend Actors (profile) search, returns only skeleton.
Parameters
cursor
string
Optional
Optional pagination mechanism; may not necessarily allow scrolling through entire result set.
limit
integer
Optional
No description available.
q
string
Required
Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax.
typeahead
boolean
Optional
If true, acts as fast/simple 'typeahead' query.
viewer
string
did
Optional
DID of the account making the request (not included for public/unauthenticated queries). Used to boost followed accounts in ranking.
Output
application/jsonactors
array
Required
No description available.
cursor
string
Optional
No description available.
hitsTotal
integer
Optional
Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.
Errors
BadQueryString
Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Backend Actors (profile) search, returns only skeleton.",
"errors": [
{
"name": "BadQueryString"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"actors": {
"items": {
"ref": "town.delve.unspecced.defs#skeletonSearchActor",
"type": "ref"
},
"type": "array"
},
"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"
}
},
"required": [
"actors"
],
"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; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax.",
"type": "string"
},
"typeahead": {
"description": "If true, acts as fast/simple 'typeahead' query.",
"type": "boolean"
},
"viewer": {
"description": "DID of the account making the request (not included for public/unauthenticated queries). Used to boost followed accounts in ranking.",
"format": "did",
"type": "string"
}
},
"required": [
"q"
],
"type": "params"
},
"type": "query"
}