Skip to main content
Polaris uses API key authentication. Send your key in the Authorization header as a bearer token for authenticated requests.

​
Header format

Authorization: Bearer pk_live_your_key

​
When auth is required

SurfaceAuth requirement
GET /catalogPublic
GET /snapshotsPublic
GET /snapshots/downloadPublic unless the dataset access policy requires bearer auth
GET /tradesPublic for limited recent access; bearer auth for broader historical queries
GET /eventsPublic for limited recent access; bearer auth for broader historical queries
GET /ohlcvPublic for limited recent access; bearer auth for broader historical queries
GET /rawBearer auth required

​
Shared request patterns

PatternNotes
exchange + assetCommon market selector across data endpoints
from + toExplicit time bounds; often requires bearer auth on direct query endpoints
limitPage size; defaults and maximums vary by endpoint
cursorOpaque token used to fetch the next page

​
Example

curl \
  -H "Authorization: Bearer pk_live_your_key" \
  "https://api.polaris.supply/trades?exchange=binance&asset=BTC-USDT&from=2024-01-01T00:00:00Z&to=2024-01-01T01:00:00Z&limit=100"

​
Next steps

  • Read Catalog before you build authenticated market-specific requests.
  • Read Trades API or Events API for endpoint-specific query behavior.
  • Read Quickstart if you want the fastest end-to-end path to first data.