Skip to main content
GET
Download Snapshots

Download Snapshots

Returns a short-lived download link to one market’s complete snapshot history as a single Parquet file. Every snapshot of the market is in the file, with full order books, so you don’t need to page through Get Snapshots.
Requires a Pro, Suite, or Enterprise plan. The market must also be inside your plan’s data window.
Files are created after a market ends, usually within a day. For a market that is still running or has only just ended, use Get Snapshots.

Request

Headers

string
required
Your API key. See Authentication.

Path parameters

string
required
The market slug, e.g. btc-updown-5m-1788140100

Response

object
The market object (same as Get Market)
string
File format. Always parquet.
string
Download link for the file. It works without your API key and expires at expires_at. The file downloads as {slug}.parquet.
string
When the link stops working (ISO 8601)
integer
Seconds until the link expires (currently 600, i.e. 10 minutes)
integer
File size in bytes
string
SHA-256 checksum of the file (hex), for verifying the download
integer
Number of snapshots in the file

Examples

Response

market is truncated here; it has all the fields from Get Market. Treat url as an opaque link: its host and format can change.
Request the link right before you download. If it has expired, call this endpoint again for a fresh one. Downloading the file itself doesn’t count against your rate limit.

Errors

See Error Handling for the error response format.