Skip to main content
You do not need an API key for every Polaris workflow. Many first-run tasks work without authentication, including public catalog access and public-window queries on some endpoints. Add a Polaris API key when you need broader access, explicit historical ranges on restricted endpoints, or access that matches your account tier.

​
When to use an API key

Use a bearer token when:
  • You need explicit from and to ranges on endpoints that restrict those fields for public requests.
  • You need older preview data that sits outside the public window.
  • You want access that reflects your account tier.

​
Bearer auth

curl \
  -H "Authorization: Bearer pk_live_your_key" \
  "https://api.polaris.supply/trades?exchange=binance&asset=BTC-USDT&limit=100"

​
Where you use the API key

Use the same Polaris API key across:

​
Authentication notes

  • Public requests work for some endpoints and are the easiest place to start.
  • Historical from and to queries on most data endpoints require a bearer token.
  • Snapshot downloads only require bearer auth when the dataset access policy returned by /snapshots requires it.
If you are testing access for the first time, start with the Quickstart and use the snapshots workflow before moving to higher-volume queries.

​
Next steps

  • Read Catalog before building market-specific requests.
  • Read Authentication for a tighter auth and request-pattern reference.
  • Read Python SDK or Rust SDK if you want a client library instead of direct HTTP requests.