app.bsky.actor Lexicon#

Definitions related to "actors," a general term for users in Bluesky.


app.bsky.actor.profile#

Record type

export interface Record {
  displayName: string;
  description?: string;
}

app.bsky.actor.getProfile#

RPC query

Parameters:

  • user Required string.

Response:

  • Encoding: application/json
  • Schema:
export interface Response {
  did: string;
  handle: string;
  displayName?: string;
  description?: string;
  followersCount: number;
  followsCount: number;
  postsCount: number;
  myState?: {
    follow?: string;
  };
}

app.bsky.actor.search#

RPC query Find users matching search criteria

Parameters:

  • term Required string.
  • limit Optional number. Max value 100.
  • before Optional string.

Response:

  • Encoding: application/json
  • Schema:
export interface Response {
  cursor?: string;
  users: {
    did: string;
    handle: string;
    displayName?: string;
    description?: string;
    indexedAt?: string;
  }[];
}

app.bsky.actor.searchTypeahead#

RPC query Find user suggestions for a search term

Parameters:

  • term Required string.
  • limit Optional number. Max value 100.

Response:

  • Encoding: application/json
  • Schema:
export interface Response {
  users: {
    did: string;
    handle: string;
    displayName?: string;
  }[];
}

app.bsky.actor.updateProfile#

RPC procedure Notify server that the user has seen notifications

Parameters:

  • Encoding: application/json
  • Schema:
export interface Parameters {
  displayName?: string;
  description?: string;
}

Response:

  • Encoding: application/json
  • Schema:
export interface Response {
  uri: string;
  cid: string;
  record: {};
}

See what's next.Join the private beta.

The AT Protocol will launch soon.
Join the waitlist to try the beta before it's publicly available.

Join the waitlist