Skip to main content
GET
https://api.polaris.supply
/
snapshots
/
download
Snapshot download
curl --request GET \
  --url https://api.polaris.supply/snapshots/download \
  --header 'Authorization: Bearer <token>'
{
  "redirect": "<string>",
  "url": "<string>",
  "filename": "<string>",
  "expires_in_seconds": 123
}
Use GET /snapshots/download when you already have a snapshot key from Snapshots and want to fetch the file itself.

​
Endpoint

GET /snapshots/download

​
Parameters

​
key
string
required
Snapshot key returned by GET /snapshots, such as snapshots/standard/hyperliquid/BTC-USD/2026-05-07.jsonl.zst.
​
filename
string
Optional override for the suggested download filename.
​
mode
string
Optional response mode. Use url or json to receive JSON with a pre-signed URL instead of a redirect.

​
Access behavior

  • Bearer auth is only required when the dataset access policy for the snapshot requires it.
  • Accepted key formats include the full .jsonl.zst suffix or the same key without it.
  • mode=url and mode=json both return JSON with url, filename, and expires_in_seconds.

​
Response fields

​
redirect
string
The endpoint typically responds with a redirect to the downloadable snapshot file.
​
url
string
Pre-signed download URL when you request mode=url or mode=json.
​
filename
string
Suggested filename for the artifact.
​
expires_in_seconds
number
Lifetime of the pre-signed URL.

​
Example

curl -L \
  "https://api.polaris.supply/snapshots/download?key=snapshots/standard/hyperliquid/BTC-USD/2026-05-07.jsonl.zst" \
  -o hyperliquid_BTC-USD_2026-05-07_standard.jsonl.zst

​
Next steps

  • Read Snapshots if you need to list available files before downloading one.
  • Read Standardised formats to understand the event envelope inside snapshot files.