Namespace#

class atproto.xrpc_client.namespaces.sync_ns.ActorNamespace(client: ClientRaw)#

Bases: NamespaceBase

get_preferences(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

Get private preferences attached to the account.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyActorGetPreferences.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_profile(params: Union[Params, ParamsDict], **kwargs: Any) → ProfileViewDetailed#

Get profile.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyActorDefs.ProfileViewDetailed

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_profiles(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Get profiles.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyActorGetProfiles.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_suggestions(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

Get a list of actors suggested for following. Used in discovery UIs.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyActorGetSuggestions.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

put_preferences(data: Union[Data, DataDict], **kwargs: Any) → bool#

Sets the private preferences attached to the account.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

search_actors(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

Find actors (profiles) matching search criteria.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyActorSearchActors.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

search_actors_typeahead(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

Find actor suggestions for a search term.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyActorSearchActorsTypeahead.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

class atproto.xrpc_client.namespaces.sync_ns.AdminNamespace(client: ClientRaw)#

Bases: NamespaceBase

disable_account_invites(data: Union[Data, DataDict], **kwargs: Any) → bool#

Disable an account from receiving new invite codes, but does not invalidate existing codes.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

disable_invite_codes(data: Optional[Union[Data, DataDict]] = None, **kwargs: Any) → bool#

Disable some set of codes and/or all codes associated with a set of users.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

enable_account_invites(data: Union[Data, DataDict], **kwargs: Any) → bool#

Re-enable an accounts ability to receive invite codes.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_account_info(params: Union[Params, ParamsDict], **kwargs: Any) → AccountView#

View details about an account.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoAdminDefs.AccountView

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_invite_codes(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

Admin view of invite codes.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoAdminGetInviteCodes.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_moderation_action(params: Union[Params, ParamsDict], **kwargs: Any) → ActionViewDetail#

View details about a moderation action.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoAdminDefs.ActionViewDetail

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_moderation_actions(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

List moderation actions related to a subject.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoAdminGetModerationActions.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_moderation_report(params: Union[Params, ParamsDict], **kwargs: Any) → ReportViewDetail#

View details about a moderation report.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoAdminDefs.ReportViewDetail

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_moderation_reports(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

List moderation reports related to a subject.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoAdminGetModerationReports.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_record(params: Union[Params, ParamsDict], **kwargs: Any) → RecordViewDetail#

View details about a record.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoAdminDefs.RecordViewDetail

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_repo(params: Union[Params, ParamsDict], **kwargs: Any) → RepoViewDetail#

View details about a repository.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoAdminDefs.RepoViewDetail

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_subject_status(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

Fetch the service-specific the admin status of a subject (account, record, or blob).

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoAdminGetSubjectStatus.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

resolve_moderation_reports(data: Union[Data, DataDict], **kwargs: Any) → ActionView#

Resolve moderation reports by an action.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoAdminDefs.ActionView

Raises:

atproto.exceptions.AtProtocolError – Base exception.

reverse_moderation_action(data: Union[Data, DataDict], **kwargs: Any) → ActionView#

Reverse a moderation action.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoAdminDefs.ActionView

Raises:

atproto.exceptions.AtProtocolError – Base exception.

search_repos(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

Find repositories based on a search term.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoAdminSearchRepos.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

send_email(data: Union[Data, DataDict], **kwargs: Any) → Response#

Send email to a user’s primary email address.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoAdminSendEmail.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

take_moderation_action(data: Union[Data, DataDict], **kwargs: Any) → ActionView#

Take a moderation action on a repo.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoAdminDefs.ActionView

Raises:

atproto.exceptions.AtProtocolError – Base exception.

update_account_email(data: Union[Data, DataDict], **kwargs: Any) → bool#

Administrative action to update an account’s email.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

update_account_handle(data: Union[Data, DataDict], **kwargs: Any) → bool#

Administrative action to update an account’s handle.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

update_subject_status(data: Union[Data, DataDict], **kwargs: Any) → Response#

Update the service-specific admin status of a subject (account, record, or blob).

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoAdminUpdateSubjectStatus.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

class atproto.xrpc_client.namespaces.sync_ns.AppNamespace(client: ClientRaw)#: Bases: NamespaceBase

class atproto.xrpc_client.namespaces.sync_ns.AtprotoNamespace(client: ClientRaw)#: Bases: NamespaceBase

class atproto.xrpc_client.namespaces.sync_ns.BskyNamespace(client: ClientRaw)#: Bases: NamespaceBase

class atproto.xrpc_client.namespaces.sync_ns.ComNamespace(client: ClientRaw)#: Bases: NamespaceBase

class atproto.xrpc_client.namespaces.sync_ns.FeedNamespace(client: ClientRaw)#

Bases: NamespaceBase

describe_feed_generator(**kwargs: Any) → Response#

Returns information about a given feed generator including TOS & offered feed URIs.

Parameters:: **kwargs – Arbitrary arguments to HTTP request.
Returns:: Output model.
Return type:: models.AppBskyFeedDescribeFeedGenerator.Response
Raises:: atproto.exceptions.AtProtocolError – Base exception.

get_actor_feeds(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Retrieve a list of feeds created by a given actor.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyFeedGetActorFeeds.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_actor_likes(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

A view of the posts liked by an actor.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyFeedGetActorLikes.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_author_feed(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

A view of an actor’s feed.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyFeedGetAuthorFeed.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_feed(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Compose and hydrate a feed from a user’s selected feed generator.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyFeedGetFeed.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_feed_generator(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Get information about a specific feed offered by a feed generator, such as its online status.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyFeedGetFeedGenerator.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_feed_generators(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Get information about a list of feed generators.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyFeedGetFeedGenerators.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_feed_skeleton(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

A skeleton of a feed provided by a feed generator.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyFeedGetFeedSkeleton.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_likes(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Get likes.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyFeedGetLikes.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_list_feed(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

A view of a recent posts from actors in a list.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyFeedGetListFeed.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_post_thread(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Get post thread.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyFeedGetPostThread.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_posts(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

A view of an actor’s feed.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyFeedGetPosts.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_reposted_by(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Get reposted by.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyFeedGetRepostedBy.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_suggested_feeds(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

Get a list of suggested feeds for the viewer.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyFeedGetSuggestedFeeds.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_timeline(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

A view of the user’s home timeline.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyFeedGetTimeline.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

search_posts(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Find posts matching search criteria.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyFeedSearchPosts.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

class atproto.xrpc_client.namespaces.sync_ns.GraphNamespace(client: ClientRaw)#

Bases: NamespaceBase

get_blocks(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

Who is the requester’s account blocking?

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyGraphGetBlocks.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_followers(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Who is following an actor?

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyGraphGetFollowers.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_follows(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Who is an actor following?

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyGraphGetFollows.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_list(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Fetch a list of actors.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyGraphGetList.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_list_blocks(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

Which lists is the requester’s account blocking?

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyGraphGetListBlocks.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_list_mutes(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

Which lists is the requester’s account muting?

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyGraphGetListMutes.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_lists(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Fetch a list of lists that belong to an actor.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyGraphGetLists.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_mutes(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

Who does the viewer mute?

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyGraphGetMutes.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_suggested_follows_by_actor(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Get suggested follows related to a given actor.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyGraphGetSuggestedFollowsByActor.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

mute_actor(data: Union[Data, DataDict], **kwargs: Any) → bool#

Mute an actor by did or handle.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

mute_actor_list(data: Union[Data, DataDict], **kwargs: Any) → bool#

Mute a list of actors.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

unmute_actor(data: Union[Data, DataDict], **kwargs: Any) → bool#

Unmute an actor by did or handle.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

unmute_actor_list(data: Union[Data, DataDict], **kwargs: Any) → bool#

Unmute a list of actors.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

class atproto.xrpc_client.namespaces.sync_ns.IdentityNamespace(client: ClientRaw)#

Bases: NamespaceBase

resolve_handle(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Provides the DID of a repo.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoIdentityResolveHandle.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

update_handle(data: Union[Data, DataDict], **kwargs: Any) → bool#

Updates the handle of the account.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

class atproto.xrpc_client.namespaces.sync_ns.LabelNamespace(client: ClientRaw)#

Bases: NamespaceBase

query_labels(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Find labels relevant to the provided URI patterns.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoLabelQueryLabels.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

class atproto.xrpc_client.namespaces.sync_ns.ModerationNamespace(client: ClientRaw)#

Bases: NamespaceBase

create_report(data: Union[Data, DataDict], **kwargs: Any) → Response#

Report a repo or a record.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoModerationCreateReport.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

class atproto.xrpc_client.namespaces.sync_ns.NotificationNamespace(client: ClientRaw)#

Bases: NamespaceBase

get_unread_count(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

Get unread count.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyNotificationGetUnreadCount.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

list_notifications(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

List notifications.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyNotificationListNotifications.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

register_push(data: Union[Data, DataDict], **kwargs: Any) → bool#

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

update_seen(data: Union[Data, DataDict], **kwargs: Any) → bool#

Notify server that the user has seen notifications.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

class atproto.xrpc_client.namespaces.sync_ns.RepoNamespace(client: ClientRaw)#

Bases: NamespaceBase

apply_writes(data: Union[Data, DataDict], **kwargs: Any) → bool#

Apply a batch transaction of creates, updates, and deletes.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

create_record(data: Union[Data, DataDict], **kwargs: Any) → Response#

Create a new record.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoRepoCreateRecord.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

delete_record(data: Union[Data, DataDict], **kwargs: Any) → bool#

Delete a record, or ensure it doesn’t exist.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

describe_repo(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Get information about the repo, including the list of collections.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoRepoDescribeRepo.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_record(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Get a record.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoRepoGetRecord.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

list_records(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

List a range of records in a collection.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoRepoListRecords.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

put_record(data: Union[Data, DataDict], **kwargs: Any) → Response#

Write a record, creating or updating it as needed.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoRepoPutRecord.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

upload_blob(data: bytes, **kwargs: Any) → Response#

Upload a new blob to be added to repo in a later request.

Parameters:

data – Input data alias.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoRepoUploadBlob.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

class atproto.xrpc_client.namespaces.sync_ns.ServerNamespace(client: ClientRaw)#

Bases: NamespaceBase

confirm_email(data: Union[Data, DataDict], **kwargs: Any) → bool#

Confirm an email using a token from com.atproto.server.requestEmailConfirmation.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

create_account(data: Union[Data, DataDict], **kwargs: Any) → Response#

Create an account.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoServerCreateAccount.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

create_app_password(data: Union[Data, DataDict], **kwargs: Any) → AppPassword#

Create an app-specific password.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoServerCreateAppPassword.AppPassword

Raises:

atproto.exceptions.AtProtocolError – Base exception.

create_invite_code(data: Union[Data, DataDict], **kwargs: Any) → Response#

Create an invite code.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoServerCreateInviteCode.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

create_invite_codes(data: Union[Data, DataDict], **kwargs: Any) → Response#

Create an invite code.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoServerCreateInviteCodes.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

create_session(data: Union[Data, DataDict], **kwargs: Any) → Response#

Create an authentication session.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoServerCreateSession.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

delete_account(data: Union[Data, DataDict], **kwargs: Any) → bool#

Delete a user account with a token and password.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

delete_session(**kwargs: Any) → bool#

Delete the current session.

Parameters:: **kwargs – Arbitrary arguments to HTTP request.
Returns:: Success status.
Return type:: bool
Raises:: atproto.exceptions.AtProtocolError – Base exception.

describe_server(**kwargs: Any) → Response#

Get a document describing the service’s accounts configuration.

Parameters:: **kwargs – Arbitrary arguments to HTTP request.
Returns:: Output model.
Return type:: models.ComAtprotoServerDescribeServer.Response
Raises:: atproto.exceptions.AtProtocolError – Base exception.

get_account_invite_codes(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

Get all invite codes for a given account.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoServerGetAccountInviteCodes.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_session(**kwargs: Any) → Response#

Get information about the current session.

Parameters:: **kwargs – Arbitrary arguments to HTTP request.
Returns:: Output model.
Return type:: models.ComAtprotoServerGetSession.Response
Raises:: atproto.exceptions.AtProtocolError – Base exception.

list_app_passwords(**kwargs: Any) → Response#

List all app-specific passwords.

Parameters:: **kwargs – Arbitrary arguments to HTTP request.
Returns:: Output model.
Return type:: models.ComAtprotoServerListAppPasswords.Response
Raises:: atproto.exceptions.AtProtocolError – Base exception.

refresh_session(**kwargs: Any) → Response#

Refresh an authentication session.

Parameters:: **kwargs – Arbitrary arguments to HTTP request.
Returns:: Output model.
Return type:: models.ComAtprotoServerRefreshSession.Response
Raises:: atproto.exceptions.AtProtocolError – Base exception.

request_account_delete(**kwargs: Any) → bool#

Initiate a user account deletion via email.

Parameters:: **kwargs – Arbitrary arguments to HTTP request.
Returns:: Success status.
Return type:: bool
Raises:: atproto.exceptions.AtProtocolError – Base exception.

request_email_confirmation(**kwargs: Any) → bool#

Request an email with a code to confirm ownership of email.

Parameters:: **kwargs – Arbitrary arguments to HTTP request.
Returns:: Success status.
Return type:: bool
Raises:: atproto.exceptions.AtProtocolError – Base exception.

request_email_update(**kwargs: Any) → Response#

Request a token in order to update email.

Parameters:: **kwargs – Arbitrary arguments to HTTP request.
Returns:: Output model.
Return type:: models.ComAtprotoServerRequestEmailUpdate.Response
Raises:: atproto.exceptions.AtProtocolError – Base exception.

request_password_reset(data: Union[Data, DataDict], **kwargs: Any) → bool#

Initiate a user account password reset via email.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

reserve_signing_key(data: Optional[Union[Data, DataDict]] = None, **kwargs: Any) → Response#

Reserve a repo signing key for account creation.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoServerReserveSigningKey.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

reset_password(data: Union[Data, DataDict], **kwargs: Any) → bool#

Reset a user account password using a token.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

revoke_app_password(data: Union[Data, DataDict], **kwargs: Any) → bool#

Revoke an app-specific password by name.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

update_email(data: Union[Data, DataDict], **kwargs: Any) → bool#

Update an account’s email.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

class atproto.xrpc_client.namespaces.sync_ns.SyncNamespace(client: ClientRaw)#

Bases: NamespaceBase

get_blob(params: Union[Params, ParamsDict], **kwargs: Any) → bytes#

Get a blob associated with a given repo.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoSyncGetBlob.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_blocks(params: Union[Params, ParamsDict], **kwargs: Any) → bytes#

Gets blocks from a given repo.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoSyncGetBlocks.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_checkout(params: Union[Params, ParamsDict], **kwargs: Any) → bytes#

DEPRECATED - please use com.atproto.sync.getRepo instead.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoSyncGetCheckout.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_head(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

DEPRECATED - please use com.atproto.sync.getLatestCommit instead.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoSyncGetHead.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_latest_commit(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Gets the current commit CID & revision of the repo.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoSyncGetLatestCommit.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_record(params: Union[Params, ParamsDict], **kwargs: Any) → bytes#

Gets blocks needed for existence or non-existence of record.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoSyncGetRecord.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_repo(params: Union[Params, ParamsDict], **kwargs: Any) → bytes#

Gets the did’s repo, optionally catching up from a specific revision.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoSyncGetRepo.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

list_blobs(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

List blob cids since some revision.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoSyncListBlobs.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

list_repos(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

List dids and root cids of hosted repos.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.ComAtprotoSyncListRepos.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

notify_of_update(data: Union[Data, DataDict], **kwargs: Any) → bool#

Notify a crawling service of a recent update. Often when a long break between updates causes the connection with the crawling service to break.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

request_crawl(data: Union[Data, DataDict], **kwargs: Any) → bool#

Request a service to persistently crawl hosted repos.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

class atproto.xrpc_client.namespaces.sync_ns.UnspeccedNamespace(client: ClientRaw)#

Bases: NamespaceBase

apply_labels(data: Union[Data, DataDict], **kwargs: Any) → bool#

Allow a labeler to apply labels directly.

Parameters:

data – Input data.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_popular(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

DEPRECATED: will be removed soon, please find a feed generator alternative.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyUnspeccedGetPopular.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_popular_feed_generators(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

An unspecced view of globally popular feed generators.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyUnspeccedGetPopularFeedGenerators.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_timeline_skeleton(params: Optional[Union[Params, ParamsDict]] = None, **kwargs: Any) → Response#

A skeleton of a timeline - UNSPECCED & WILL GO AWAY SOON.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyUnspeccedGetTimelineSkeleton.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

search_actors_skeleton(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Backend Actors (profile) search, returning only skeleton.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyUnspeccedSearchActorsSkeleton.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

search_posts_skeleton(params: Union[Params, ParamsDict], **kwargs: Any) → Response#

Backend Posts search, returning only skeleton.

Parameters:

params – Parameters.
**kwargs – Arbitrary arguments to HTTP request.

Returns:

Output model.

Return type:

models.AppBskyUnspeccedSearchPostsSkeleton.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.