Skip to main content
This quickstart takes you from zero to a local Polaris dataset file. It uses the historical snapshots workflow because it is the fastest way to confirm access and inspect the standardised schema.

​
Prerequisites

Before you begin, you need:
  • A Polaris account and API key
  • curl
  • zstd or another tool that can decompress .zst files

​
Download your first file

1

Generate an API key

Create an API key in your Polaris account. Use it as a bearer token for authenticated requests.
export POLARIS_API_KEY="pk_live_your_key"
2

Choose a market

Use GET /catalog to find a valid exchange and asset pair.
curl "https://api.polaris.supply/catalog?exchange=hyperliquid&asset=BTC-USD"
3

List available snapshots

Request daily snapshot files for the market and date range you want.
curl "https://api.polaris.supply/snapshots?exchange=hyperliquid&asset=BTC-USD&from=2026-05-07T00:00:00Z&to=2026-05-07T03:00:00Z&limit=2"
4

Download one snapshot

Copy a key from the previous response, then follow the redirect to download the file.
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
5

Decompress and inspect it

Snapshot files are compressed JSON Lines. Decompress them locally before loading them into your own pipeline.
zstd -d hyperliquid_BTC-USD_2026-05-07_standard.jsonl.zst
Next, read Connecting, Catalog, and Snapshots to understand authentication, coverage discovery, and download behavior in more detail.

​
Next steps

Need help with access or dataset coverage? Email hello@polaris.supply.