Skip to main content

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

    q string

    Search query prefix; not a full query string.

    limit integer

    Possible values: >= 1 and <= 100

    Default value: 10

Responses​

OK

Schema

    actors

    object[]

    required

  • Array [

    • did didrequired
    handle handlerequired
    displayName string

    Possible values: <= 640 characters

    avatar uri

    associated

    object

    lists integer
    feedgens integer
    starterPacks integer
    labeler boolean

    chat

    object

    allowIncoming stringrequired

    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.

    muted boolean

    mutedByList

    object

    uri at-urirequired
    cid cidrequired
    name stringrequired

    Possible values: non-empty and <= 64 characters

    purpose

    object

    required

    oneOf

    string

    avatar uri
    listItemCount integer

    labels

    object[]

  • Array [

    • ver integer
    src didrequired

    DID of the actor who created this label.

    uri urirequired

    AT URI of the record, repository (account), or other resource that this label applies to.

    cid cid

    Optionally, CID specifying the specific version of 'uri' resource this label applies to.

    val stringrequired

    Possible values: <= 128 characters

    The short string name of the value or type of this label.

    neg boolean

    If true, this is a negation label, overwriting a previous label.

    cts date-timerequired

    Timestamp when this label was created.

    exp date-time

    Timestamp at which this label expires (no longer applies).

    sig byte

    Signature of dag-cbor encoded label.

  • ]

    • viewer

    object

    muted boolean
    blocked at-uri
    indexedAt date-time
    blockedBy boolean
    blocking at-uri

    blockingByList

    object

    uri at-urirequired
    cid cidrequired
    name stringrequired

    Possible values: non-empty and <= 64 characters

    purpose

    object

    required

    oneOf

    string

    avatar uri
    listItemCount integer

    labels

    object[]

  • Array [

    • ver integer
    src didrequired

    DID of the actor who created this label.

    uri urirequired

    AT URI of the record, repository (account), or other resource that this label applies to.

    cid cid

    Optionally, CID specifying the specific version of 'uri' resource this label applies to.

    val stringrequired

    Possible values: <= 128 characters

    The short string name of the value or type of this label.

    neg boolean

    If true, this is a negation label, overwriting a previous label.

    cts date-timerequired

    Timestamp when this label was created.

    exp date-time

    Timestamp at which this label expires (no longer applies).

    sig byte

    Signature of dag-cbor encoded label.

  • ]

    • viewer

    object

    muted boolean
    blocked at-uri
    indexedAt date-time
    following at-uri
    followedBy at-uri

    knownFollowers

    object

    The subject's followers whom you also follow

    count integerrequired
    followers undefined[]required

    Possible values: <= 5

    labels

    object[]

  • Array [

    • ver integer
    src didrequired

    DID of the actor who created this label.

    uri urirequired

    AT URI of the record, repository (account), or other resource that this label applies to.

    cid cid

    Optionally, CID specifying the specific version of 'uri' resource this label applies to.

    val stringrequired

    Possible values: <= 128 characters

    The short string name of the value or type of this label.

    neg boolean

    If true, this is a negation label, overwriting a previous label.

    cts date-timerequired

    Timestamp when this label was created.

    exp date-time

    Timestamp at which this label expires (no longer applies).

    sig byte

    Signature of dag-cbor encoded label.

  • ]

    • createdAt date-time

  • ]

Loading...