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
Kindprocedure
Authorityjetstream.bsky.network
Indexed

Procedure

procedure · POST

Input

application/json

afterSeq

integer

Start after this sequence number. Events at or below it are not included.

  • minimum: 0

beforeSeq

integer

Stop at this sequence number. Events above it are not included.

  • minimum: 0

Collection 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
itemsstring

dids

array

Only include data for these DIDs. Omit this field or pass an empty array to include all DIDs.

  • maxLength: 10000
itemsstring · did

kinds

array

Event kinds to include. Omit this field or pass an empty array to include all kinds.

  • maxLength: 4
itemsstring
  • enum: commit | identity | account | sync

Output

application/json

plannedThroughSeq

requiredinteger

The 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

sealedTipSeq

requiredinteger

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

segments

requiredarray
itemsref
Reference

stats

requiredref
Reference

#blockRange

object

Properties

first

requiredinteger

Index of the first block in the range.

  • minimum: 0

last

requiredinteger

Index of the last block in the range.

  • minimum: 0

#segment

object

Properties

blocks

array

Block ranges to download, including both endpoints. This field is present only when mode is blocks.

itemsref
Reference

checksum

requiredstring

The segment's xxh3 metadata checksum, encoded as 16 hexadecimal characters.

  • minLength: 16
  • maxLength: 16

index

requiredinteger

Zero-based segment index.

  • minimum: 0

maxSeq

requiredinteger
  • minimum: 0

minSeq

requiredinteger
  • minimum: 0

mode

requiredstring

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

name

requiredstring

Segment filename to pass to getSegment or getBlock.

#stats

object

Properties

blocksMatched

requiredinteger
  • minimum: 0

entries

requiredinteger

Number of items counted toward the server's per-page plan limit.

  • minimum: 0

segmentsExamined

requiredinteger
  • minimum: 0

segmentsMatched

requiredinteger
  • minimum: 0

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.