Bluesky
This is the HTTP API reference for Bluesky. It covers the app.bsky.*, com.atproto.*, chat.bsky.*, and tools.ozone.* Lexicon namespaces — the Lexicons…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This is the HTTP API reference for Bluesky. It covers the app.bsky.*, com.atproto.*, chat.bsky.*, and tools.ozone.* Lexicon namespaces — the Lexicons implemented by the Bluesky application, its related services (DMs, Ozone moderation), and the AT Protocol PDS those services build on. Use the document switcher in the top left to move between endpoints.
The wider AT Protocol Lexicon ecosystem is open and any service can publish its own Lexicons. For an index of community Lexicons see lexicon.garden, and for the schema language itself see the Lexicon guide.
Authentication and request routing
These endpoints don't all live on the same host, and where a request should be sent depends on whether the caller is authenticated:
- Most
app.bsky.*GETs are public and can be called without authentication against the Bluesky AppView athttps://public.api.bsky.app.POSTs (writes) and any endpoint that returns account-private data require auth. - Authenticated requests should be sent to the user's own PDS. The PDS validates the session and, if needed, proxies the request to the correct backend. Proxied requests should include an
atproto-proxyheader. Bluesky DMs and Ozone Moderation requests always require proxying.
For client libraries that handle session management and proxying for you, see the AT Protocol SDKs.
To consume the whole network as a live, filterable JSON firehose (or replay a slice of it), see the Jetstream API.
Endpoints 152
app.bsky.actor
- GETapp.bsky.actor.getPreferences
/xrpc/app.bsky.actor.getPreferencesGet private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration.… - GETapp.bsky.actor.getProfile
/xrpc/app.bsky.actor.getProfile?actor=stringGet detailed profile view of an actor. Does not require auth, but contains relevant metadata with auth. - GETapp.bsky.actor.getProfiles
/xrpc/app.bsky.actor.getProfiles?actors=stringGet detailed profile views of multiple actors. - GETapp.bsky.actor.getSuggestions
/xrpc/app.bsky.actor.getSuggestionsGet a list of suggested actors. Expected use is discovery of accounts to follow during new account onboarding. - POSTapp.bsky.actor.putPreferences
/xrpc/app.bsky.actor.putPreferencesSet the private preferences attached to the account. - GETapp.bsky.actor.searchActors
/xrpc/app.bsky.actor.searchActorsFind actors (profiles) matching search criteria. Does not require auth. - GETapp.bsky.actor.searchActorsTypeahead
/xrpc/app.bsky.actor.searchActorsTypeaheadFind actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth.
app.bsky.ageassurance
- POSTapp.bsky.ageassurance.begin
/xrpc/app.bsky.ageassurance.beginInitiate Age Assurance for an account. - GETapp.bsky.ageassurance.getConfig
/xrpc/app.bsky.ageassurance.getConfigReturns Age Assurance configuration for use on the client. - GETapp.bsky.ageassurance.getState
/xrpc/app.bsky.ageassurance.getState?countryCode=stringReturns server-computed Age Assurance state, if available, and any additional metadata needed to compute Age Assurance state client-side.
app.bsky.bookmark
- POSTapp.bsky.bookmark.createBookmark
/xrpc/app.bsky.bookmark.createBookmarkCreates a private bookmark for the specified record. Currently, only app.bsky.feed.post records are supported. Requires authentication. - POSTapp.bsky.bookmark.deleteBookmark
/xrpc/app.bsky.bookmark.deleteBookmarkDeletes a private bookmark for the specified record. Currently, only app.bsky.feed.post records are supported. Requires authentication. - GETapp.bsky.bookmark.getBookmarks
/xrpc/app.bsky.bookmark.getBookmarksGets views of records bookmarked by the authenticated user. Requires authentication.
app.bsky.contact
- POSTapp.bsky.contact.dismissMatch
/xrpc/app.bsky.contact.dismissMatchRemoves a match that was found via contact import. It shouldn't appear again if the same contact is re-imported. Requires authentication. - GETapp.bsky.contact.getMatches
/xrpc/app.bsky.contact.getMatchesReturns the matched contacts (contacts that were mutually imported). Excludes dismissed matches. Requires authentication. - GETapp.bsky.contact.getSyncStatus
/xrpc/app.bsky.contact.getSyncStatusGets the user's current contact import status. Requires authentication. - POSTapp.bsky.contact.importContacts
/xrpc/app.bsky.contact.importContactsImport contacts for securely matching with other users. This follows the protocol explained in https://docs.bsky.app/blog/contact-import-rfc. Requires… - POSTapp.bsky.contact.removeData
/xrpc/app.bsky.contact.removeDataRemoves all stored hashes used for contact matching, existing matches, and sync status. Requires authentication. - POSTapp.bsky.contact.sendNotification
/xrpc/app.bsky.contact.sendNotificationSystem endpoint to send notifications related to contact imports. Requires role authentication. - POSTapp.bsky.contact.startPhoneVerification
/xrpc/app.bsky.contact.startPhoneVerificationStarts a phone verification flow. The phone passed will receive a code via SMS that should be passed to app.bsky.contact.verifyPhone. Requires authentication. - POSTapp.bsky.contact.verifyPhone
/xrpc/app.bsky.contact.verifyPhoneVerifies control over a phone number with a code received via SMS and starts a contact import session. Requires authentication.
app.bsky.draft
- POSTapp.bsky.draft.createDraft
/xrpc/app.bsky.draft.createDraftInserts a draft using private storage (stash). An upper limit of drafts might be enforced. Requires authentication. - POSTapp.bsky.draft.deleteDraft
/xrpc/app.bsky.draft.deleteDraftDeletes a draft by ID. Requires authentication. - GETapp.bsky.draft.getDrafts
/xrpc/app.bsky.draft.getDraftsGets views of user drafts. Requires authentication. - POSTapp.bsky.draft.updateDraft
/xrpc/app.bsky.draft.updateDraftUpdates a draft using private storage (stash). If the draft ID points to a non-existing ID, the update will be silently ignored. This is done because updates…
app.bsky.feed
- GETapp.bsky.feed.describeFeedGenerator
/xrpc/app.bsky.feed.describeFeedGeneratorGet information about a feed generator, including policies and offered feed URIs. Does not require auth; implemented by Feed Generator services (not App View). - GETapp.bsky.feed.getActorFeeds
/xrpc/app.bsky.feed.getActorFeeds?actor=stringGet a list of feeds (feed generator records) created by the actor (in the actor's repo). - GETapp.bsky.feed.getActorLikes
/xrpc/app.bsky.feed.getActorLikes?actor=stringGet a list of posts liked by an actor. Requires auth, actor must be the requesting account. - GETapp.bsky.feed.getAuthorFeed
/xrpc/app.bsky.feed.getAuthorFeed?actor=stringGet a view of an actor's 'author feed' (post and reposts by the author). Does not require auth. - GETapp.bsky.feed.getFeed
/xrpc/app.bsky.feed.getFeed?feed=stringGet a hydrated feed from an actor's selected feed generator. Implemented by App View. - GETapp.bsky.feed.getFeedGenerator
/xrpc/app.bsky.feed.getFeedGenerator?feed=stringGet information about a feed generator. Implemented by AppView. - GETapp.bsky.feed.getFeedGenerators
/xrpc/app.bsky.feed.getFeedGenerators?feeds=stringGet information about a list of feed generators. - GETapp.bsky.feed.getFeedSkeleton
/xrpc/app.bsky.feed.getFeedSkeleton?feed=stringGet a skeleton of a feed provided by a feed generator. Auth is optional, depending on provider requirements, and provides the DID of the requester.… - GETapp.bsky.feed.getLikes
/xrpc/app.bsky.feed.getLikes?uri=stringGet like records which reference a subject (by AT-URI and CID). - GETapp.bsky.feed.getListFeed
/xrpc/app.bsky.feed.getListFeed?list=stringGet a feed of recent posts from a list (posts and reposts from any actors on the list). Does not require auth. - GETapp.bsky.feed.getPostThread
/xrpc/app.bsky.feed.getPostThread?uri=stringGet posts in a thread. Does not require auth, but additional metadata and filtering will be applied for authed requests. - GETapp.bsky.feed.getPosts
/xrpc/app.bsky.feed.getPosts?uris=stringGets post views for a specified list of posts (by AT-URI). This is sometimes referred to as 'hydrating' a 'feed skeleton'. - GETapp.bsky.feed.getQuotes
/xrpc/app.bsky.feed.getQuotes?uri=stringGet a list of quotes for a given post. - GETapp.bsky.feed.getRepostedBy
/xrpc/app.bsky.feed.getRepostedBy?uri=stringGet a list of reposts for a given post. - GETapp.bsky.feed.getSuggestedFeeds
/xrpc/app.bsky.feed.getSuggestedFeedsGet a list of suggested feeds (feed generators) for the requesting account. - GETapp.bsky.feed.getTimeline
/xrpc/app.bsky.feed.getTimelineGet a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed. - GETapp.bsky.feed.searchPosts
/xrpc/app.bsky.feed.searchPosts?q=stringFind posts matching search criteria, returning views of those posts. Note that this API endpoint may require authentication (eg, not public) for some service… - POSTapp.bsky.feed.sendInteractions
/xrpc/app.bsky.feed.sendInteractionsSend information about interactions with feed items back to the feed generator that served them.
app.bsky.graph
- GETapp.bsky.graph.getActorStarterPacks
/xrpc/app.bsky.graph.getActorStarterPacks?actor=stringGet a list of starter packs created by the actor. - GETapp.bsky.graph.getBlocks
/xrpc/app.bsky.graph.getBlocksEnumerates which accounts the requesting account is currently blocking. Requires auth. - GETapp.bsky.graph.getFollowers
/xrpc/app.bsky.graph.getFollowers?actor=stringEnumerates accounts which follow a specified account (actor). - GETapp.bsky.graph.getFollows
/xrpc/app.bsky.graph.getFollows?actor=stringEnumerates accounts which a specified account (actor) follows. - GETapp.bsky.graph.getKnownFollowers
/xrpc/app.bsky.graph.getKnownFollowers?actor=stringEnumerates accounts which follow a specified account (actor) and are followed by the viewer. - GETapp.bsky.graph.getList
/xrpc/app.bsky.graph.getList?list=stringGets a 'view' (with additional context) of a specified list. - GETapp.bsky.graph.getListBlocks
/xrpc/app.bsky.graph.getListBlocksGet mod lists that the requesting account (actor) is blocking. Requires auth. - GETapp.bsky.graph.getListMutes
/xrpc/app.bsky.graph.getListMutesEnumerates mod lists that the requesting account (actor) currently has muted. Requires auth. - GETapp.bsky.graph.getLists
/xrpc/app.bsky.graph.getLists?actor=stringEnumerates the lists created by a specified account (actor). - GETapp.bsky.graph.getListsWithMembership
/xrpc/app.bsky.graph.getListsWithMembership?actor=stringEnumerates the lists created by the session user, and includes membership information about actor in those lists. Only supports curation and moderation lists… - GETapp.bsky.graph.getMutes
/xrpc/app.bsky.graph.getMutesEnumerates accounts that the requesting account (actor) currently has muted. Requires auth. - GETapp.bsky.graph.getRelationships
/xrpc/app.bsky.graph.getRelationships?actor=stringEnumerates public relationships between one account, and a list of other accounts. Does not require auth. - GETapp.bsky.graph.getStarterPack
/xrpc/app.bsky.graph.getStarterPack?starterPack=stringGets a view of a starter pack. - GETapp.bsky.graph.getStarterPacks
/xrpc/app.bsky.graph.getStarterPacks?uris=stringGet views for a list of starter packs. - GETapp.bsky.graph.getStarterPacksWithMembership
/xrpc/app.bsky.graph.getStarterPacksWithMembership?actor=stringEnumerates the starter packs created by the session user, and includes membership information about actor in those starter packs. Requires auth. - GETapp.bsky.graph.getSuggestedFollowsByActor
/xrpc/app.bsky.graph.getSuggestedFollowsByActor?actor=stringEnumerates follows similar to a given account (actor). Expected use is to recommend additional accounts immediately after following one account. - POSTapp.bsky.graph.muteActor
/xrpc/app.bsky.graph.muteActorCreates a mute relationship for the specified account. Mutes are private in Bluesky. Requires auth. - POSTapp.bsky.graph.muteActorList
/xrpc/app.bsky.graph.muteActorListCreates a mute relationship for the specified list of accounts. Mutes are private in Bluesky. Requires auth. - POSTapp.bsky.graph.muteThread
/xrpc/app.bsky.graph.muteThreadMutes a thread preventing notifications from the thread and any of its children. Mutes are private in Bluesky. Requires auth. - GETapp.bsky.graph.searchStarterPacks
/xrpc/app.bsky.graph.searchStarterPacks?q=stringFind starter packs matching search criteria. Requires auth. - POSTapp.bsky.graph.unmuteActor
/xrpc/app.bsky.graph.unmuteActorUnmutes the specified account. Requires auth. - POSTapp.bsky.graph.unmuteActorList
/xrpc/app.bsky.graph.unmuteActorListUnmutes the specified list of accounts. Requires auth. - POSTapp.bsky.graph.unmuteThread
/xrpc/app.bsky.graph.unmuteThreadUnmutes the specified thread. Requires auth.
app.bsky.labeler
- GETapp.bsky.labeler.getServices
/xrpc/app.bsky.labeler.getServices?dids=stringGet information about a list of labeler services.
app.bsky.notification
- GETapp.bsky.notification.getPreferences
/xrpc/app.bsky.notification.getPreferencesGet notification-related preferences for an account. Requires auth. - GETapp.bsky.notification.getUnreadCount
/xrpc/app.bsky.notification.getUnreadCountCount the number of unread notifications for the requesting account. Requires auth. - GETapp.bsky.notification.listActivitySubscriptions
/xrpc/app.bsky.notification.listActivitySubscriptionsEnumerate all accounts to which the requesting account is subscribed to receive notifications for. Requires auth. - GETapp.bsky.notification.listNotifications
/xrpc/app.bsky.notification.listNotificationsEnumerate notifications for the requesting account. Requires auth. - POSTapp.bsky.notification.putActivitySubscription
/xrpc/app.bsky.notification.putActivitySubscriptionPuts an activity subscription entry. The key should be omitted for creation and provided for updates. Requires auth. - POSTapp.bsky.notification.putPreferences
/xrpc/app.bsky.notification.putPreferencesSet notification-related preferences for an account. Requires auth. - POSTapp.bsky.notification.putPreferencesV2
/xrpc/app.bsky.notification.putPreferencesV2Set notification-related preferences for an account. Requires auth. - POSTapp.bsky.notification.registerPush
/xrpc/app.bsky.notification.registerPushRegister to receive push notifications, via a specified service, for the requesting account. Requires auth. - POSTapp.bsky.notification.unregisterPush
/xrpc/app.bsky.notification.unregisterPushThe inverse of registerPush - inform a specified service that push notifications should no longer be sent to the given token for the requesting account.… - POSTapp.bsky.notification.updateSeen
/xrpc/app.bsky.notification.updateSeenNotify server that the requesting account has seen notifications. Requires auth.
app.bsky.video
- GETapp.bsky.video.getJobStatus
/xrpc/app.bsky.video.getJobStatus?jobId=stringGet status details for a video processing job. - GETapp.bsky.video.getUploadLimits
/xrpc/app.bsky.video.getUploadLimitsGet video upload limits for the authenticated user. - POSTapp.bsky.video.uploadVideo
/xrpc/app.bsky.video.uploadVideoUpload a video to be processed then stored on the PDS.
com.atproto.admin
- POSTcom.atproto.admin.deleteAccount
/xrpc/com.atproto.admin.deleteAccountDelete a user account as an administrator. - POSTcom.atproto.admin.disableAccountInvites
/xrpc/com.atproto.admin.disableAccountInvitesDisable an account from receiving new invite codes, but does not invalidate existing codes. - POSTcom.atproto.admin.disableInviteCodes
/xrpc/com.atproto.admin.disableInviteCodesDisable some set of codes and/or all codes associated with a set of users. - POSTcom.atproto.admin.enableAccountInvites
/xrpc/com.atproto.admin.enableAccountInvitesRe-enable an account's ability to receive invite codes. - GETcom.atproto.admin.getAccountInfo
/xrpc/com.atproto.admin.getAccountInfo?did=stringGet details about an account. - GETcom.atproto.admin.getAccountInfos
/xrpc/com.atproto.admin.getAccountInfos?dids=stringGet details about some accounts. - GETcom.atproto.admin.getInviteCodes
/xrpc/com.atproto.admin.getInviteCodesGet an admin view of invite codes. - GETcom.atproto.admin.getSubjectStatus
/xrpc/com.atproto.admin.getSubjectStatusGet the service-specific admin status of a subject (account, record, or blob). - GETcom.atproto.admin.searchAccounts
/xrpc/com.atproto.admin.searchAccountsGet list of accounts that matches your search query. - POSTcom.atproto.admin.sendEmail
/xrpc/com.atproto.admin.sendEmailSend email to a user's account email address. - POSTcom.atproto.admin.updateAccountEmail
/xrpc/com.atproto.admin.updateAccountEmailAdministrative action to update an account's email. - POSTcom.atproto.admin.updateAccountHandle
/xrpc/com.atproto.admin.updateAccountHandleAdministrative action to update an account's handle. - POSTcom.atproto.admin.updateAccountPassword
/xrpc/com.atproto.admin.updateAccountPasswordUpdate the password for a user account as an administrator. - POSTcom.atproto.admin.updateAccountSigningKey
/xrpc/com.atproto.admin.updateAccountSigningKeyAdministrative action to update an account's signing key in their Did document. - POSTcom.atproto.admin.updateSubjectStatus
/xrpc/com.atproto.admin.updateSubjectStatusUpdate the service-specific admin status of a subject (account, record, or blob).
com.atproto.identity
- GETcom.atproto.identity.getRecommendedDidCredentials
/xrpc/com.atproto.identity.getRecommendedDidCredentialsDescribe the credentials that should be included in the DID doc of an account that is migrating to this service. - POSTcom.atproto.identity.refreshIdentity
/xrpc/com.atproto.identity.refreshIdentityRequest that the server re-resolve an identity (DID and handle). The server may ignore this request, or require authentication, depending on the role,… - POSTcom.atproto.identity.requestPlcOperationSignature
/xrpc/com.atproto.identity.requestPlcOperationSignatureRequest an email with a code to in order to request a signed PLC operation. Requires Auth. - GETcom.atproto.identity.resolveHandle
/xrpc/com.atproto.identity.resolveHandle?handle=stringResolves an atproto handle (hostname) to a DID. Does not necessarily bi-directionally verify against the the DID document. - POSTcom.atproto.identity.signPlcOperation
/xrpc/com.atproto.identity.signPlcOperationSigns a PLC operation to update some value(s) in the requesting DID's document. - POSTcom.atproto.identity.submitPlcOperation
/xrpc/com.atproto.identity.submitPlcOperationValidates a PLC operation to ensure that it doesn't violate a service's constraints or get the identity into a bad state, then submits it to the PLC registry - POSTcom.atproto.identity.updateHandle
/xrpc/com.atproto.identity.updateHandleUpdates the current account's handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth.
com.atproto.label
- GETcom.atproto.label.queryLabels
/xrpc/com.atproto.label.queryLabels?uriPatterns=stringFind labels relevant to the provided AT-URI patterns. Public endpoint for moderation services, though may return different or additional results with auth.
com.atproto.moderation
- POSTcom.atproto.moderation.createReport
/xrpc/com.atproto.moderation.createReportSubmit a moderation report regarding an atproto account or record. Implemented by moderation services (with PDS proxying), and requires auth.
com.atproto.repo
- POSTcom.atproto.repo.applyWrites
/xrpc/com.atproto.repo.applyWritesApply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS. - POSTcom.atproto.repo.createRecord
/xrpc/com.atproto.repo.createRecordCreate a single new repository record. Requires auth, implemented by PDS. - POSTcom.atproto.repo.deleteRecord
/xrpc/com.atproto.repo.deleteRecordDelete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS. - GETcom.atproto.repo.describeRepo
/xrpc/com.atproto.repo.describeRepo?repo=stringGet information about an account and repository, including the list of collections. Does not require auth. - GETcom.atproto.repo.getRecord
/xrpc/com.atproto.repo.getRecord?repo=string&rkey=string&collection=stringGet a single record from a repository. Does not require auth. - POSTcom.atproto.repo.importRepo
/xrpc/com.atproto.repo.importRepoImport a repo in the form of a CAR file. Requires Content-Length HTTP header to be set. - GETcom.atproto.repo.listMissingBlobs
/xrpc/com.atproto.repo.listMissingBlobsReturns a list of missing blobs for the requesting account. Intended to be used in the account migration flow. - GETcom.atproto.repo.listRecords
/xrpc/com.atproto.repo.listRecords?repo=string&collection=stringList a range of records in a repository, matching a specific collection. Does not require auth. - POSTcom.atproto.repo.putRecord
/xrpc/com.atproto.repo.putRecordWrite a repository record, creating or updating it as needed. Requires auth, implemented by PDS. - POSTcom.atproto.repo.uploadBlob
/xrpc/com.atproto.repo.uploadBlobUpload a new blob, to be referenced from a repository record. The blob will be deleted if it is not referenced within a time window (eg, minutes). Blob…
com.atproto.server
- POSTcom.atproto.server.activateAccount
/xrpc/com.atproto.server.activateAccountActivates a currently deactivated account. Used to finalize account migration after the account's repo is imported and identity is setup. - GETcom.atproto.server.checkAccountStatus
/xrpc/com.atproto.server.checkAccountStatusReturns the status of an account, especially as pertaining to import or recovery. Can be called many times over the course of an account migration. Requires… - POSTcom.atproto.server.confirmEmail
/xrpc/com.atproto.server.confirmEmailConfirm an email using a token from com.atproto.server.requestEmailConfirmation. - POSTcom.atproto.server.createAccount
/xrpc/com.atproto.server.createAccountCreate an account. Implemented by PDS. - POSTcom.atproto.server.createAppPassword
/xrpc/com.atproto.server.createAppPasswordCreate an App Password. - POSTcom.atproto.server.createInviteCode
/xrpc/com.atproto.server.createInviteCodeCreate an invite code. - POSTcom.atproto.server.createInviteCodes
/xrpc/com.atproto.server.createInviteCodesCreate invite codes. - POSTcom.atproto.server.createSession
/xrpc/com.atproto.server.createSessionCreate an authentication session. - POSTcom.atproto.server.deactivateAccount
/xrpc/com.atproto.server.deactivateAccountDeactivates a currently active account. Stops serving of repo, and future writes to repo until reactivated. Used to finalize account migration with the old… - POSTcom.atproto.server.deleteAccount
/xrpc/com.atproto.server.deleteAccountDelete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth. - POSTcom.atproto.server.deleteSession
/xrpc/com.atproto.server.deleteSessionDelete the current session. Requires auth using the 'refreshJwt' (not the 'accessJwt'). - GETcom.atproto.server.describeServer
/xrpc/com.atproto.server.describeServerDescribes the server's account creation requirements and capabilities. Implemented by PDS. - GETcom.atproto.server.getAccountInviteCodes
/xrpc/com.atproto.server.getAccountInviteCodesGet all invite codes for the current account. Requires auth. - GETcom.atproto.server.getServiceAuth
/xrpc/com.atproto.server.getServiceAuth?aud=stringGet a signed token on behalf of the requesting DID for the requested service. - GETcom.atproto.server.getSession
/xrpc/com.atproto.server.getSessionGet information about the current auth session. Requires auth. - GETcom.atproto.server.listAppPasswords
/xrpc/com.atproto.server.listAppPasswordsList all App Passwords. - POSTcom.atproto.server.refreshSession
/xrpc/com.atproto.server.refreshSessionRefresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt'). - POSTcom.atproto.server.requestAccountDelete
/xrpc/com.atproto.server.requestAccountDeleteInitiate a user account deletion via email. - POSTcom.atproto.server.requestEmailConfirmation
/xrpc/com.atproto.server.requestEmailConfirmationRequest an email with a code to confirm ownership of email. - POSTcom.atproto.server.requestEmailUpdate
/xrpc/com.atproto.server.requestEmailUpdateRequest a token in order to update email. - POSTcom.atproto.server.requestPasswordReset
/xrpc/com.atproto.server.requestPasswordResetInitiate a user account password reset via email. - POSTcom.atproto.server.reserveSigningKey
/xrpc/com.atproto.server.reserveSigningKeyReserve a repo signing key, for use with account creation. Necessary so that a DID PLC update operation can be constructed during an account migraiton. Public… - POSTcom.atproto.server.resetPassword
/xrpc/com.atproto.server.resetPasswordReset a user account password using a token. - POSTcom.atproto.server.revokeAppPassword
/xrpc/com.atproto.server.revokeAppPasswordRevoke an App Password by name. - POSTcom.atproto.server.updateEmail
/xrpc/com.atproto.server.updateEmailUpdate an account's email.
com.atproto.sync
- GETcom.atproto.sync.getBlob
/xrpc/com.atproto.sync.getBlob?cid=string&did=stringGet a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS. - GETcom.atproto.sync.getBlocks
/xrpc/com.atproto.sync.getBlocks?did=string&cids=stringGet data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS. - GETcom.atproto.sync.getHostStatus
/xrpc/com.atproto.sync.getHostStatus?hostname=stringReturns information about a specified upstream host, as consumed by the server. Implemented by relays. - GETcom.atproto.sync.getLatestCommit
/xrpc/com.atproto.sync.getLatestCommit?did=stringGet the current commit CID & revision of the specified repo. Does not require auth. - GETcom.atproto.sync.getRecord
/xrpc/com.atproto.sync.getRecord?did=string&rkey=string&collection=stringGet data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth. - GETcom.atproto.sync.getRepo
/xrpc/com.atproto.sync.getRepo?did=stringDownload a repository export as CAR file. Optionally only a 'diff' since a previous revision. Does not require auth; implemented by PDS. - GETcom.atproto.sync.getRepoStatus
/xrpc/com.atproto.sync.getRepoStatus?did=stringGet the hosting status for a repository, on this server. Expected to be implemented by PDS and Relay. - GETcom.atproto.sync.listBlobs
/xrpc/com.atproto.sync.listBlobs?did=stringList blob CIDs for an account, since some repo revision. Does not require auth; implemented by PDS. - GETcom.atproto.sync.listHosts
/xrpc/com.atproto.sync.listHostsEnumerates upstream hosts (eg, PDS or relay instances) that this service consumes from. Implemented by relays. - GETcom.atproto.sync.listRepos
/xrpc/com.atproto.sync.listReposEnumerates all the DID, rev, and commit CID for all repos hosted by this service. Does not require auth; implemented by PDS and Relay. - GETcom.atproto.sync.listReposByCollection
/xrpc/com.atproto.sync.listReposByCollection?collection=stringEnumerates all the DIDs which have records with the given collection NSID. - POSTcom.atproto.sync.notifyOfUpdate
/xrpc/com.atproto.sync.notifyOfUpdateNotify a crawling service of a recent update, and that crawling should resume. Intended use is after a gap between repo stream events caused the crawling… - POSTcom.atproto.sync.requestCrawl
/xrpc/com.atproto.sync.requestCrawlRequest a service to persistently crawl hosted repos. Expected use is new PDS instances declaring their existence to Relays. Does not require auth.
API details
- Base URL
https://public.api.bsky.apphttps://{host}https://bsky.network- Authentication
- A bearer token in the Authorization header
- Operations
- 152 operations on 152 pathsGET 82POST 70
- Main resources
- com.atproto.server 25app.bsky.graph 23app.bsky.feed 18com.atproto.admin 15com.atproto.sync 13app.bsky.notification 10com.atproto.repo 10app.bsky.contact 8app.bsky.actor 7com.atproto.identity 7
- Response formats
application/jsonapplication/vnd.ipld.car*/*- Description format
- OpenAPI 3.1.0
- Links
- OpenAPI document
How to test the Bluesky in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Bluesky collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “app.bsky.actor.getPreferences” (GET /xrpc/app.bsky.actor.getPreferences), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Bluesky?
This is the HTTP API reference for Bluesky. It covers the app.bsky.*, com.atproto.*, chat.bsky.*, and tools.ozone.* Lexicon namespaces — the Lexicons… It is listed under Social and has 152 endpoints.
Who publishes the Bluesky?
It is listed from Bsky's public API description (an OpenAPI document), not published by Bsky on Swastik Codes. Anyone who controls bsky.app can claim the profile by adding a DNS TXT record.
What is the base URL of the Bluesky?
Its description lists 3 base URLs: https://public.api.bsky.app, https://{host}, https://bsky.network. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Bluesky?
With A bearer token in the Authorization header.
How many endpoints does the Bluesky have?
152 operations on 152 paths (82 GET, 70 POST). The largest groups are com.atproto.server, app.bsky.graph, app.bsky.feed, com.atproto.admin.
Is forking the Bluesky free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.