com.atproto.sync.subscribeRepos
Repository event stream, aka Firehose endpoint. Outputs repo commits with diff data, and identity update events, for all repositories on the current server. See the atproto specifications for details around stream sequencing, repo versioning, CAR diff format, and more. Public and does not require auth; implemented by PDS and Relay.
- class atproto_client.models.com.atproto.sync.subscribe_repos.Params
Bases:
ParamsModelBaseParameters model for
com.atproto.sync.subscribeRepos.
- class atproto_client.models.com.atproto.sync.subscribe_repos.ParamsDict
Bases:
TypedDict- cursor: NotRequired[int | None]
The last known event seq number to backfill from.
- class atproto_client.models.com.atproto.sync.subscribe_repos.Commit
Bases:
ModelBaseDefinition model for
com.atproto.sync.subscribeRepos. Represents an update of repository state. Note that empty commits are allowed, which include no repo data changes, but an update to rev and signature.- field blobs: List[CIDType] [Required]
Blobs. DEPRECATED – will soon always be empty. List of new blobs (by CID) referenced by records in this commit.
- field blocks: str | bytes [Required]
CAR file containing relevant blocks, as a diff since the previous repo state. The commit must be included as a block, and the commit block CID must be the first entry in the CAR header ‘roots’ list.
- field commit: CIDType [Required]
Repo commit object CID.
- Constraints:
__module__ = atproto_core.cid.cid
__firstlineno__ = 147
__get_pydantic_core_schema__ = <bound method _CIDPydanticAnnotation.__get_pydantic_core_schema__ of <class ‘atproto_core.cid.cid._CIDPydanticAnnotation’>>
__get_pydantic_json_schema__ = <bound method _CIDPydanticAnnotation.__get_pydantic_json_schema__ of <class ‘atproto_core.cid.cid._CIDPydanticAnnotation’>>
__static_attributes__ = ()
__dict__ = {‘__module__’: ‘atproto_core.cid.cid’, ‘__firstlineno__’: 147, ‘__get_pydantic_core_schema__’: <classmethod(<function _CIDPydanticAnnotation.__get_pydantic_core_schema__ at 0x786e5ef0dbc0>)>, ‘__get_pydantic_json_schema__’: <classmethod(<function _CIDPydanticAnnotation.__get_pydantic_json_schema__ at 0x786e5ef0dc60>)>, ‘__static_attributes__’: (), ‘__dict__’: <attribute ‘__dict__’ of ‘_CIDPydanticAnnotation’ objects>, ‘__weakref__’: <attribute ‘__weakref__’ of ‘_CIDPydanticAnnotation’ objects>, ‘__doc__’: None}
__weakref__ = <attribute ‘__weakref__’ of ‘_CIDPydanticAnnotation’ objects>
- field ops: List[models.ComAtprotoSyncSubscribeRepos.RepoOp] [Required]
Ops. List of repo mutation operations in this commit (eg, records created, updated, or deleted).
- Constraints:
max_length = 200
- field rebase: bool [Required]
DEPRECATED – unused.
- field repo: Did [Required]
The repo this event comes from. Note that all other message types name this field ‘did’.
- field rev: Tid [Required]
The rev of the emitted commit. Note that this information is also in the commit object included in blocks, unless this is a tooBig event.
- field seq: int [Required]
The stream sequence number of this message.
- field time: DateTime [Required]
Timestamp of when this message was originally broadcast.
- field too_big: bool [Required]
DEPRECATED – replaced by #sync event and data limits. Indicates that this commit contained too many ops, or data size was too large. Consumers will need to make a separate request to get missing data.
- class atproto_client.models.com.atproto.sync.subscribe_repos.Sync
Bases:
ModelBaseDefinition model for
com.atproto.sync.subscribeRepos. Updates the repo to a new state, without necessarily including that state on the firehose. Used to recover from broken commit streams, data loss incidents, or in situations where upstream host does not know recent state of the repository.- field blocks: str | bytes [Required]
CAR file containing the commit, as a block. The CAR header must include the commit block CID as the first ‘root’.
- field did: Did [Required]
The account this repo event corresponds to. Must match that in the commit object.
- field rev: str [Required]
The rev of the commit. This value must match that in the commit object.
- field seq: int [Required]
The stream sequence number of this message.
- field time: DateTime [Required]
Timestamp of when this message was originally broadcast.
- class atproto_client.models.com.atproto.sync.subscribe_repos.Identity
Bases:
ModelBaseDefinition model for
com.atproto.sync.subscribeRepos. Represents a change to an account’s identity. Could be an updated handle, signing key, or pds hosting endpoint. Serves as a prod to all downstream services to refresh their identity cache.- field did: Did [Required]
Did.
- field seq: int [Required]
Seq.
- field time: DateTime [Required]
Time.
- class atproto_client.models.com.atproto.sync.subscribe_repos.Account
Bases:
ModelBaseDefinition model for
com.atproto.sync.subscribeRepos. Represents a change to an account’s status on a host (eg, PDS or Relay). The semantics of this event are that the status is at the host which emitted the event, not necessarily that at the currently active PDS. Eg, a Relay takedown would emit a takedown with active=false, even if the PDS is still active.- field active: bool [Required]
Indicates that the account has a repository which can be fetched from the host that emitted this event.
- field did: Did [Required]
Did.
- field seq: int [Required]
Seq.
- field status: Literal['takendown', 'suspended', 'deleted', 'deactivated', 'desynchronized', 'throttled'] | str | None = None
If active=false, this optional field indicates a reason for why the account is not active.
- field time: DateTime [Required]
Time.
- class atproto_client.models.com.atproto.sync.subscribe_repos.Info
Bases:
ModelBaseDefinition model for
com.atproto.sync.subscribeRepos.
- class atproto_client.models.com.atproto.sync.subscribe_repos.RepoOp
Bases:
ModelBaseDefinition model for
com.atproto.sync.subscribeRepos. A repo operation, ie a mutation of a single record.- field path: str [Required]
Path.