fyi.opensocial.getActor Documentation (EN)

main query

Get a person as a view names them: handle, name and avatar. Requires auth. Answers for the caller themselves, or for anyone the host shows — a member of a group it runs, or someone asking to join one.

Parameters

actor string did Required

DID of the person.

Output

Encodingapplication/json

Schemafyi.opensocial.defs#actorView

Errors

ActorNotFound

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

actor * DID of the person.

View raw schema

{
  "description": "Get a person as a view names them: handle, name and avatar. Requires auth. Answers for the caller themselves, or for anyone the host shows — a member of a group it runs, or someone asking to join one.",
  "errors": [
    {
      "name": "ActorNotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "ref": "fyi.opensocial.defs#actorView",
      "type": "ref"
    }
  },
  "parameters": {
    "properties": {
      "actor": {
        "description": "DID of the person.",
        "format": "did",
        "type": "string"
      }
    },
    "required": [
      "actor"
    ],
    "type": "params"
  },
  "type": "query"
}