network.bsky.jetstream.planSnapshot
Build a download plan for the desired data pattern. The plan lists whole segments or block ranges that might contain events for the requested kinds, DIDs, and collections.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | jetstream.bsky.network |
| Indexed |
Procedure
procedure · POSTInput
application/jsonafterSeq
integerStart after this sequence number. Events at or below it are not included.
minimum: 0
beforeSeq
integerStop at this sequence number. Events above it are not included.
minimum: 0
collections
arrayCollection NSIDs or namespace wildcards such as app.bsky.feed.*; constrains commit events only. Non-commit kinds are unaffected, so combine with kinds=commit for a commits-only collection plan. Rejected when kinds is set and excludes commit. Omit or pass an empty array to include all collections.
maxLength: 100
dids
arrayOnly include data for these DIDs. Omit this field or pass an empty array to include all DIDs.
maxLength: 10000
kinds
arrayEvent kinds to include. Omit this field or pass an empty array to include all kinds.
maxLength: 4
enum: commit | identity | account | sync
Output
application/jsonThe last sealed sequence covered by this page. Use this value as afterSeq for the next page. If the response hits the server's page limit, this is the maxSeq of the last item returned; otherwise it equals sealedTipSeq. Planning is complete when plannedThroughSeq reaches sealedTipSeq.
minimum: 0
The end of the sealed archive for this snapshot, capped by beforeSeq when provided. Use this value as beforeSeq on later pages so the snapshot does not move while it is being downloaded.
minimum: 0
#blockRange
object#segment
objectProperties
blocks
arrayBlock ranges to download, including both endpoints. This field is present only when mode is blocks.
The segment's xxh3 metadata checksum, encoded as 16 hexadecimal characters.
minLength: 16maxLength: 16
Zero-based segment index.
minimum: 0
minimum: 0
minimum: 0
How to download this segment. For segment, download the whole file with getSegment. For blocks, download the ranges listed in blocks with getBlock.
knownValues: segment | blocks
Segment filename to pass to getSegment or getBlock.
#stats
objectProperties
minimum: 0
Number of items counted toward the server's per-page plan limit.
minimum: 0
minimum: 0
minimum: 0
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
Enumerate sealed segment files available for download, in ascending index order.