com.atproto.sync.subscribeRepos

#main

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.

Input

Property	Type	Known Values	Required	Description
cursor	integer	-	❌	The last known event seq number to backfill from.

Output

Property	Type	Known Values	Required	Description
refs	union of #commit #identity #handle #migrate #tombstone #info	-	✅	-

#commit

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.

Property	Type	Known Values	Required	Description
seq	integer	-	✅	The stream sequence number of this message.
rebase	boolean	-	✅	DEPRECATED -- unused
tooBig	boolean	-	✅	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.
repo	string (did)	-	✅	The repo this event comes from.
commit	cid-link	-	✅	Repo commit object CID.
prev	cid-link	-	❌	DEPRECATED -- unused. WARNING -- nullable and optional; stick with optional to ensure golang interoperability.
rev	string	-	✅	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.
since	string	-	✅	The rev of the last emitted commit from this repo (if any).
blocks	bytes	-	✅	CAR file containing relevant blocks, as a diff since the previous repo state.
ops	array of #repoOp	-	✅	-
blobs	array of cid-link	-	✅	-
time	string (datetime)	-	✅	Timestamp of when this message was originally broadcast.

#identity

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.

Property	Type	Known Values	Required	Description
seq	integer	-	✅	-
did	string (did)	-	✅	-
time	string (datetime)	-	✅	-

#handle

Represents an update of the account's handle, or transition to/from invalid state. NOTE: Will be deprecated in favor of #identity.

Property	Type	Known Values	Required	Description
seq	integer	-	✅	-
did	string (did)	-	✅	-
handle	string (handle)	-	✅	-
time	string (datetime)	-	✅	-

#migrate

Represents an account moving from one PDS instance to another. NOTE: not implemented; account migration uses #identity instead

Property	Type	Known Values	Required	Description
seq	integer	-	✅	-
did	string (did)	-	✅	-
migrateTo	string	-	✅	-
time	string (datetime)	-	✅	-

#tombstone

Indicates that an account has been deleted. NOTE: may be deprecated in favor of #identity or a future #account event

Property	Type	Known Values	Required	Description
seq	integer	-	✅	-
did	string (did)	-	✅	-
time	string (datetime)	-	✅	-

#info

Property	Type	Known Values	Required	Description
name	string	OutdatedCursor	✅	-
message	string	-	❌	-

#repoOp

A repo operation, ie a mutation of a single record.

Property	Type	Known Values	Required	Description
action	string	create update delete	✅	-
path	string	-	✅	-
cid	cid-link	-	✅	For creates and updates, the new record CID. For deletions, null.