Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AT Protocol actor API

Actor (user) profile, search, and preference operations

AT Protocol actor API is one of 9 APIs that AT Protocol publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include actor. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 6 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://public.api.bsky.app/xrpc, https://api.bsky.app/xrpc.

6 operations 6 paths 5 schemas 5 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://bsky.social/xrpc
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

AT Protocol actor API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated, though some operations may also be called without credentials.

  • bearerAuth — Access JWT obtained from com.atproto.server.createSession

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 5 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

actor 6

Actor (user) profile, search, and preference operations

GET
/app.bsky.actor.getProfile
Get Profile
app_bsky_actor_getProfile 1 param → 200400
GET
/app.bsky.actor.getProfiles
Get Profiles
app_bsky_actor_getProfiles 1 param → 200400
GET
/app.bsky.actor.searchActors
Search Actors
app_bsky_actor_searchActors 3 params → 200400
GET
/app.bsky.actor.getPreferences
Get Preferences
app_bsky_actor_getPreferences → 200400401
POST
/app.bsky.actor.putPreferences
Put Preferences
app_bsky_actor_putPreferences body → 200400401
GET
/app.bsky.actor.getSuggestions
Get Suggestions
app_bsky_actor_getSuggestions 2 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ProfileViewDetailed (14 properties), ProfileView (10 properties), ViewerState (8 properties), Label (8 properties). Each schema is shown below with its type and property counts.

Label
object
8 properties 4 required
ProfileViewDetailed
object
14 properties 2 required
Error
object
2 properties 2 required
ViewerState
object
Metadata about the relationship between the requesting account and the subject account.
8 properties
ProfileView
object
10 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atproto-actor-api-openapi.yml Raw ↑

Other APIs AT Protocol publishes across the network.

AT Protocol Firehose (Event Stream)
AT Protocol feed API
AT Protocol graph API
AT Protocol identity API
AT Protocol notification API
AT Protocol repo API
AT Protocol server API
AT Protocol sync API