app.bsky.actor.searchActorsTypeahead
GET/xrpc/app.bsky.actor.searchActorsTypeahead
This endpoint is part of the Bluesky application Lexicon APIs (app.bsky.*
). Public endpoints which don't require authentication can be made directly against the public Bluesky AppView API: https://public.api.bsky.app. Authenticated requests are usually made to the user's PDS, with automatic service proxying. Authenticated requests can be used for both public and non-public endpoints.
To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.
Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth.
Request
Query Parameters
Search query prefix; not a full query string.
Possible values: >= 1
and <= 100
Default value: 10
Responses
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
- app.bsky.graph.defs.modlist
- app.bsky.graph.defs.curatelist
- app.bsky.graph.defs.referencelist
Array [
]
- app.bsky.graph.defs.modlist
- app.bsky.graph.defs.curatelist
- app.bsky.graph.defs.referencelist
Array [
]
Array [
]
]
actors
object[]
required
Possible values: <= 640 characters
associated
object
chat
object
Possible values: [all
, none
, following
]
viewer
object
Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.
mutedByList
object
Possible values: non-empty
and <= 64 characters
purpose
object
required
oneOf
string
string
string
labels
object[]
DID of the actor who created this label.
AT URI of the record, repository (account), or other resource that this label applies to.
Optionally, CID specifying the specific version of 'uri' resource this label applies to.
Possible values: <= 128 characters
The short string name of the value or type of this label.
If true, this is a negation label, overwriting a previous label.
Timestamp when this label was created.
Timestamp at which this label expires (no longer applies).
Signature of dag-cbor encoded label.
viewer
object
blockingByList
object
Possible values: non-empty
and <= 64 characters
purpose
object
required
oneOf
string
string
string
labels
object[]
DID of the actor who created this label.
AT URI of the record, repository (account), or other resource that this label applies to.
Optionally, CID specifying the specific version of 'uri' resource this label applies to.
Possible values: <= 128 characters
The short string name of the value or type of this label.
If true, this is a negation label, overwriting a previous label.
Timestamp when this label was created.
Timestamp at which this label expires (no longer applies).
Signature of dag-cbor encoded label.
viewer
object
knownFollowers
object
The subject's followers whom you also follow
Possible values: <= 5
labels
object[]
DID of the actor who created this label.
AT URI of the record, repository (account), or other resource that this label applies to.
Optionally, CID specifying the specific version of 'uri' resource this label applies to.
Possible values: <= 128 characters
The short string name of the value or type of this label.
If true, this is a negation label, overwriting a previous label.
Timestamp when this label was created.
Timestamp at which this label expires (no longer applies).
Signature of dag-cbor encoded label.
{
"actors": [
{
"did": "string",
"handle": "string",
"displayName": "string",
"avatar": "string",
"associated": {
"lists": 0,
"feedgens": 0,
"starterPacks": 0,
"labeler": true,
"chat": {
"allowIncoming": "all"
}
},
"viewer": {
"muted": true,
"mutedByList": {
"uri": "string",
"cid": "string",
"name": "string",
"purpose": "string",
"avatar": "string",
"listItemCount": 0,
"labels": [
{
"ver": 0,
"src": "string",
"uri": "string",
"cid": "string",
"val": "string",
"neg": true,
"cts": "2024-10-08T00:27:26.618Z",
"exp": "2024-10-08T00:27:26.618Z",
"sig": "string"
}
],
"viewer": {
"muted": true,
"blocked": "string"
},
"indexedAt": "2024-10-08T00:27:26.618Z"
},
"blockedBy": true,
"blocking": "string",
"blockingByList": {
"uri": "string",
"cid": "string",
"name": "string",
"purpose": "string",
"avatar": "string",
"listItemCount": 0,
"labels": [
{
"ver": 0,
"src": "string",
"uri": "string",
"cid": "string",
"val": "string",
"neg": true,
"cts": "2024-10-08T00:27:26.618Z",
"exp": "2024-10-08T00:27:26.618Z",
"sig": "string"
}
],
"viewer": {
"muted": true,
"blocked": "string"
},
"indexedAt": "2024-10-08T00:27:26.618Z"
},
"following": "string",
"followedBy": "string",
"knownFollowers": {
"count": 0,
"followers": [
null
]
}
},
"labels": [
{
"ver": 0,
"src": "string",
"uri": "string",
"cid": "string",
"val": "string",
"neg": true,
"cts": "2024-10-08T00:27:26.618Z",
"exp": "2024-10-08T00:27:26.618Z",
"sig": "string"
}
],
"createdAt": "2024-10-08T00:27:26.618Z"
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [InvalidRequest
, ExpiredToken
, InvalidToken
]
{
"error": "InvalidRequest",
"message": "string"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
{
"message": "string"
}