ClientΒΆ

class atproto_client.client.client.Client(base_url: str | None = None, *args: Any, **kwargs: Any)ΒΆ

Bases: SessionDispatchMixin, SessionMethodsMixin, TimeMethodsMixin, ClientRaw

High-level client for XRPC of ATProto.

app: sync_ns.AppNamespaceΒΆ
chat: sync_ns.ChatNamespaceΒΆ
com: sync_ns.ComNamespaceΒΆ
delete_follow(follow_uri: str) boolΒΆ

Alias for unfollow

delete_like(like_uri: str) boolΒΆ

Alias for unlike

delete_post(post_uri: str) boolΒΆ

Delete post.

Parameters:

post_uri – AT URI of the post.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

delete_repost(repost_uri: str) boolΒΆ

Alias for unrepost

export_session_string() strΒΆ

Export session string.

Note

This method is useful for storing the session and reusing it later.

Warning

You should use it if you create the client instance often. Because of server rate limits for createSession. Rate limited by handle. 30/5 min, 300/day.

Attention

You must export session at the end of the Client`s life cycle! Alternatively, you can subscribe to the session change event. Use on_session_change to register handler.

Example

>>> from atproto import Client
>>> # the first time login with login and password
>>> client = Client()
>>> client.login('login', 'password')
>>> session_string = client.export_session_string()
>>> # store session_string somewhere.
>>> # for example, in env and next time use it for login
>>> client2 = Client()
>>> client2.login(session_string=session_string)
Returns:

Session string.

Return type:

str

follow(subject: str) CreateRecordResponseΒΆ

Follow the profile.

Parameters:

subject – DID of the profile.

Returns:

Reference to the created record.

Return type:

models.AppBskyGraphFollow.CreateRecordResponse

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_author_feed(actor: str, cursor: str | None = None, filter: str | None = None, limit: int | None = None) ResponseΒΆ

Get author (profile) feed.

Parameters:
  • actor – Actor (handle or DID).

  • cursor – Cursor of the last like in the previous page.

  • filter – Filter.

  • limit – Limit count of likes to return.

Returns:

Feed.

Return type:

models.AppBskyFeedGetAuthorFeed.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_current_time() datetimeΒΆ

Get current time in Server Timezone (UTC).

get_current_time_iso() strΒΆ

Get current time in Server Timezone (UTC) and ISO format.

get_followers(actor: str, cursor: str | None = None, limit: int | None = None) ResponseΒΆ

Get followers of the profile.

Parameters:
  • actor – Actor (handle or DID).

  • cursor – Cursor of the next page.

  • limit – Limit count of followers to return.

Returns:

Followers.

Return type:

models.AppBskyGraphGetFollowers.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_follows(actor: str, cursor: str | None = None, limit: int | None = None) ResponseΒΆ

Get follows of the profile.

Parameters:
  • actor – Actor (handle or DID).

  • cursor – Cursor of the next page.

  • limit – Limit count of follows to return.

Returns:

Follows.

Return type:

models.AppBskyGraphGetFollows.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_likes(uri: str, cid: str | None = None, cursor: str | None = None, limit: int | None = None) ResponseΒΆ

Get likes.

Parameters:
  • uri – AT URI.

  • cid – CID.

  • cursor – Cursor of the last like in the previous page.

  • limit – Limit count of likes to return.

Returns:

Likes.

Return type:

models.AppBskyFeedGetLikes.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_post(post_rkey: str, profile_identify: str | None = None, cid: str | None = None) GetRecordResponseΒΆ

Get post.

Parameters:
  • post_rkey – ID (slug) of the post.

  • profile_identify – Handler or DID. Who created the post.

  • cid – The CID of the version of the post.

Returns:

Post.

Return type:

models.AppBskyFeedPost.GetRecordResponse

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_post_thread(uri: str, depth: int | None = None, parent_height: int | None = None) ResponseΒΆ

Get post thread.

Parameters:
  • uri – AT URI.

  • depth – Depth of the thread.

  • parent_height – Height of the parent post.

Returns:

Post thread.

Return type:

models.AppBskyFeedGetPostThread.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_posts(uris: List[str]) ResponseΒΆ

Get posts.

Parameters:

uris – Uris (AT URI).

Example

client.get_posts(['at://did:plc:kvwvcn5iqfooopmyzvb4qzba/app.bsky.feed.post/3k2yihcrp6f2c'])
Returns:

Posts.

Return type:

models.AppBskyFeedGetPosts.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_profile(actor: str) ProfileViewDetailedΒΆ

Get profile.

Parameters:

actor – Actor (handle or DID).

Returns:

Profile.

Return type:

models.AppBskyActorDefs.ProfileViewDetailed

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_profiles(actors: List[str]) ResponseΒΆ

Get profiles.

Parameters:

actors – List of actors (handles or DIDs).

Returns:

Profiles.

Return type:

models.AppBskyActorGetProfiles.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_reposted_by(uri: str, cid: str | None = None, cursor: str | None = None, limit: int | None = None) ResponseΒΆ

Get reposted by (reposts).

Parameters:
  • uri – AT URI.

  • cid – CID.

  • cursor – Cursor of the last like in the previous page.

  • limit – Limit count of likes to return.

Returns:

Reposts.

Return type:

models.AppBskyFeedGetRepostedBy.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

get_time_from_timestamp(timestamp: int) datetimeΒΆ

Get datetime from timestamp in Server Timezone (UTC).

get_timeline(algorithm: str | None = None, cursor: str | None = None, limit: int | None = None) ResponseΒΆ

Get home timeline.

Parameters:
  • algorithm – Algorithm.

  • cursor – Cursor of the last like in the previous page.

  • limit – Limit count of likes to return.

Returns:

Home timeline.

Return type:

models.AppBskyFeedGetTimeline.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

invoke_procedure(nsid: str, params: ParamsModelBase | None = None, data: DataModelBase | bytes | None = None, **kwargs: Any) ResponseΒΆ
invoke_query(nsid: str, params: ParamsModelBase | None = None, data: DataModelBase | bytes | None = None, **kwargs: Any) ResponseΒΆ
like(uri: str, cid: str) CreateRecordResponseΒΆ

Like the record.

Parameters:
  • cid – The CID of the record.

  • uri – The URI of the record.

Note

Record could be post, custom feed, etc.

Returns:

Reference to the created record.

Return type:

models.AppBskyFeedLike.CreateRecordResponse

Raises:

atproto.exceptions.AtProtocolError – Base exception.

login(login: str | None = None, password: str | None = None, session_string: str | None = None) ProfileViewDetailedΒΆ

Authorize a client and get profile info.

Parameters:
  • login – Handle/username of the account.

  • password – Main or app-specific password of the account.

  • session_string – Session string (use export_session_string to obtain it).

Note

Either session_string or login and password should be provided.

Returns:

Profile information.

Return type:

models.AppBskyActorDefs.ProfileViewDetailed

Raises:

atproto.exceptions.AtProtocolError – Base exception.

me: t.Optional['models.AppBskyActorDefs.ProfileViewDetailed']ΒΆ
mute(actor: str) boolΒΆ

Mute actor (profile).

Parameters:

actor – Actor (handle or DID).

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

on_session_change(callback: Callable[[SessionEvent, Session], None]) NoneΒΆ

Register a callback for session change event.

Parameters:

callback – A callback to be called when the session changes. The callback must accept two arguments: event and session.

Example

>>> from atproto import Client, SessionEvent, Session
>>>
>>> client = Client()
>>>
>>> def on_session_change(event: SessionEvent, session: Session):
>>>     print(event, session)
>>>
>>> client.on_session_change(on_session_change)
Returns:

None

post(text: str | TextBuilder, profile_identify: str | None = None, reply_to: ReplyRef | None = None, embed: Main | Main | Main | Main | None = None, langs: List[str] | None = None, facets: List[Main] | None = None) CreateRecordResponseΒΆ

Alias for send_post

repost(uri: str | None = None, cid: str | None = None, subject: Main | None = None) CreateRecordResponseΒΆ

Repost post.

Parameters:
  • cid – The CID of the post.

  • uri – The URI of the post.

  • subject – DEPRECATED.

Returns:

Reference to the reposted record.

Return type:

models.AppBskyFeedRepost.CreateRecordResponse

Raises:

atproto.exceptions.AtProtocolError – Base exception.

property request: RequestΒΆ
resolve_handle(handle: str) ResponseΒΆ

Resolve the handle.

Parameters:

handle – Handle.

Returns:

Resolved handle (DID).

Return type:

models.ComAtprotoIdentityResolveHandle.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.

send_image(text: str | TextBuilder, image: bytes, image_alt: str, profile_identify: str | None = None, reply_to: ReplyRef | None = None, langs: List[str] | None = None, facets: List[Main] | None = None) CreateRecordResponseΒΆ

Send post with attached image.

Note

If profile_identify is not provided will be sent to the current profile.

Parameters:
  • text – Text of the post.

  • image – Binary image to attach.

  • image_alt – Text version of the image.

  • profile_identify – Handle or DID. Where to send post.

  • reply_to – Root and parent of the post to reply to.

  • langs – List of used languages in the post.

  • facets – List of facets (rich text items).

Returns:

Reference to the created record.

Return type:

models.AppBskyFeedPost.CreateRecordResponse

Raises:

atproto.exceptions.AtProtocolError – Base exception.

send_images(text: str | TextBuilder, images: List[bytes], image_alts: List[str] | None = None, profile_identify: str | None = None, reply_to: ReplyRef | None = None, langs: List[str] | None = None, facets: List[Main] | None = None) CreateRecordResponseΒΆ

Send post with multiple attached images (up to 4 images).

Note

If profile_identify is not provided will be sent to the current profile.

Parameters:
  • text – Text of the post.

  • images – List of binary images to attach. The length must be less than or equal to 4.

  • image_alts – List of text version of the images. The length should be shorter than or equal to the length of images.

  • profile_identify – Handle or DID. Where to send post.

  • reply_to – Root and parent of the post to reply to.

  • langs – List of used languages in the post.

  • facets – List of facets (rich text items).

Returns:

Reference to the created record.

Return type:

models.AppBskyFeedPost.CreateRecordResponse

Raises:

atproto.exceptions.AtProtocolError – Base exception.

send_post(text: str | TextBuilder, profile_identify: str | None = None, reply_to: ReplyRef | None = None, embed: Main | Main | Main | Main | None = None, langs: List[str] | None = None, facets: List[Main] | None = None) CreateRecordResponseΒΆ

Send post.

Note

If profile_identify is not provided will be sent to the current profile.

The default language is en. Available languages are defined in atproto.xrpc_client.models.languages.

Parameters:
  • text – Text of the post.

  • profile_identify – Handle or DID. Where to send post.

  • reply_to – Root and parent of the post to reply to.

  • embed – Embed models that should be attached to the post.

  • langs – List of used languages in the post.

  • facets – List of facets (rich text items).

Returns:

Reference to the created record.

Return type:

models.AppBskyFeedPost.CreateRecordResponse

Raises:

atproto.exceptions.AtProtocolError – Base exception.

tools: sync_ns.ToolsNamespaceΒΆ
unfollow(follow_uri: str) boolΒΆ

Unfollow the profile.

Parameters:

follow_uri – AT URI of the follow.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

unlike(like_uri: str) boolΒΆ

Unlike the post.

Parameters:

like_uri – AT URI of the like.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

unmute(actor: str) boolΒΆ

Unmute actor (profile).

Parameters:

actor – Actor (handle or DID).

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

unrepost(repost_uri: str) boolΒΆ

Unrepost the post (delete repost).

Parameters:

repost_uri – AT URI of the repost.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

unsend(post_uri: str) boolΒΆ

Alias for delete_post

update_handle(handle: str) boolΒΆ

Update the handle.

Parameters:

handle – New handle.

Returns:

Success status.

Return type:

bool

Raises:

atproto.exceptions.AtProtocolError – Base exception.

upload_blob(data: bytes) ResponseΒΆ

Upload blob.

Parameters:

data – Binary data.

Returns:

Uploaded blob reference.

Return type:

models.ComAtprotoRepoUploadBlob.Response

Raises:

atproto.exceptions.AtProtocolError – Base exception.