is.currents.actor.defs Documentation (EN)

profileView object

No description available.

Properties

avatar string uri Optional

CDN URL of the actor's avatar image.

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes

handle string handle Required

An AT Protocol handle (e.g., alice.bsky.social).

viewer ref #profileViewerState Optional

Viewer-specific state. Only present when the request is authenticated.

View raw schema

{
  "type": "object",
  "required": [
    "did",
    "handle"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "avatar": {
      "type": "string",
      "format": "uri",
      "description": "CDN URL of the actor's avatar image."
    },
    "handle": {
      "type": "string",
      "format": "handle"
    },
    "viewer": {
      "ref": "#profileViewerState",
      "type": "ref",
      "description": "Viewer-specific state. Only present when the request is authenticated."
    },
    "displayName": {
      "type": "string",
      "maxLength": 640,
      "maxGraphemes": 64
    }
  }
}

profileViewerState object

Metadata about the requesting account's relationship with the actor. Only present when the request is authenticated.

Properties

followedBy string at-uri Optional

AT-URI of the follow record if this actor follows the viewer.

following string at-uri Optional

AT-URI of the follow record if the viewer follows this actor.

View raw schema

{
  "type": "object",
  "properties": {
    "following": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the follow record if the viewer follows this actor."
    },
    "followedBy": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the follow record if this actor follows the viewer."
    }
  },
  "description": "Metadata about the requesting account's relationship with the actor. Only present when the request is authenticated."
}