Snapshots

Fetch one snapshot's status + records

Returns a single snapshot. If pending, it is reconciled against the live extraction job first; if ready, includes all records (cached 24h for free re-fetches). Wallet-gated via SIWX — only the wallet that paid for this snapshot can read it.

get/api/snapshots/{id}

Request

  • Base URL: https://twitr.sh
  • URL: https://twitr.sh/api/snapshots/{id}
  • Auth: API key in header SIGN-IN-WITH-X

Path parameters

idstring required

Response

Snapshot is ready (includes download_url for the JSON blob) OR failed (includes error). Rate-limited to 10 download_url issuances per wallet per hour.

snapshot_idstring required
status'ready' | 'failed' required
actor_idstring
modestring
record_countinteger
bytesinteger

Size of the blob in bytes.

download_urlstring

Vercel Blob URL. Fetch with plain GET; no additional auth required. URL is stable until blob expiry (24h by default).

expires_at_estimateinteger

Unix ms when the blob will expire (estimate — blob retention is 24h after creation).

errorstring

Only when status=failed.

Changes

No recorded changes to this operation across all 1 revision of this API.