Polaris Data API and SDK Quickstart

The fastest way to get started with Polaris is the Python SDK. Install polaris-data, discover a market, and run your first query in a few lines. You do not need an API key for public data.

Prerequisites

Before you begin, you need:

Python 3.9 or later
A terminal

Install the SDK

pip install polaris-data

Discover a market

Use catalog(...) to confirm the exact market ID before you query. Market IDs are venue-specific. For Hyperliquid, use canonical IDs such as BTC.

from polaris_data import PolarisClient

with PolarisClient() as client:
    catalog = client.catalog(source="hyperliquid")
    print([row["market"] for row in catalog["markets"]])

Use Catalog for the full market discovery reference.

Query your first data

Fetch recent trades for a public market. from_ and to are optional; without them the SDK uses the most recent available window.

from polaris_data import PolarisClient

with PolarisClient() as client:
    trades = client.trades(
        source="binance",
        market="BTC-USDT",
        output="dataframe",
    )
    print(trades.head())

Add an API key when you need it

Public sources work without an API key. Add a Polaris API key when you need:

explicit from and to ranges on endpoints that restrict those fields for public requests
older preview data that sits outside the public window
access that reflects your account tier

Set the key with the POLARIS_API_KEY environment variable:

export POLARIS_API_KEY="pk_live_your_key"

Or pass it directly to the client:

from polaris_data import PolarisClient

with PolarisClient(api_key="pk_live_your_key") as client:
    trades = list(
        client.trades(
            source="hyperliquid",
            market="SPX",
            from_="2024-01-01T00:00:00Z",
            to="2024-01-02T00:00:00Z",
        )
    )

If you omit api_key, the client reads POLARIS_API_KEY from the environment.

Next steps

Read the Python SDK for the full method reference.
Read Catalog before you hardcode source and market IDs.
Read Market coverage to browse supported venues and their access tiers.
Read Jupyter Notebook if you want a notebook workflow.

Getting Started

Core Concepts

Polaris Data API and SDK Quickstart

Prerequisites

Install the SDK

Discover a market

Query your first data

Add an API key when you need it

Next steps

​Prerequisites

​Install the SDK

​Discover a market

​Query your first data

​Add an API key when you need it

​Next steps

Prerequisites

Install the SDK

Discover a market

Query your first data

Add an API key when you need it

Next steps