Quickstart

The fastest way to get started with Polaris is the CLI and TUI. It lets you browse remote datasets, download the ranges you need, and inspect local files without learning the API first.

Prerequisites

Before you begin, you need:

A terminal
Internet access

You do not need an API key for the first-run flow. Use Catalog to confirm the exact market ID before you query or download data. Market IDs are venue-specific. For Hyperliquid, use canonical IDs such as BTC.

Use Polaris with an agent

Copy this prompt into your coding agent to set up Polaris and work with market data safely:

Polaris is a tick-level market-data platform for order-book, trade, and event data from frontier venues, including Hyperliquid, Lighter, and QFEX. Supported markets may include assets such as BTC spot and AAPL perpetual futures.

First, check whether the `polaris` CLI is available. If it is not installed, explain that the Polaris CLI is recommended and ask for explicit permission before running:
`curl -fsSL https://polaris.supply/install.sh | sh`

Once the CLI is available, ask which integration the user prefers:

- Recommended for coding agents: run `polaris skills add`, then help the user browse and download market datasets.
- For MCP-based tools: run `polaris mcp add`, then help the user browse and download market datasets.

Do not run either integration command without the user’s approval.

For catalog access beyond the public datasets, recommend `polaris login`, which opens the browser and securely stores the user’s Polaris API key. Never ask the user to paste an API key into chat or reveal it in output.

Use the Polaris CLI to discover datasets and download data. For application code, use the `polaris_data` SDKs:

- Python: https://docs.polaris.supply/sdks/python.md
- Rust: https://docs.polaris.supply/sdks/rust.md
- TypeScript: https://docs.polaris.supply/sdks/typescript.md

For additional guidance, read https://docs.polaris.supply/llms.txt.

Install and run Polaris

Install the CLI

Install polaris with the official install script.

curl -fsSL https://polaris.supply/install.sh | sh

Open the TUI

Start the interactive dataset browser.

polaris

Browse a market in the terminal

If you prefer plain CLI output, inspect a specific dataset directly.

polaris catalog --source hyperliquid --market BTC

Download one time range

Download the dataset range you want.

polaris download \
  --source hyperliquid \
  --market BTC \
  --from 2026-06-01T00:00:00Z \
  --to 2026-06-02T00:00:00Z

Inspect local data

Confirm what Polaris downloaded locally.

polaris list --source hyperliquid --market BTC

You only need to sign in when you want access that goes beyond the public path. Use the browser flow:

polaris login

Or save a key manually:

polaris key

Common reasons to sign in:

You need older preview data that is outside the public window.
You want access that matches your account tier.
You want authenticated workflows saved into the CLI locally.

Prefer the API instead?

If you want to work directly with HTTP requests or the Python SDK instead of the CLI, start with:

The CLI is the easiest first-run path. The API and SDK pages are better once you know the dataset or workflow you want.

Next steps

Read Authentication to understand when bearer auth matters.
Read Market coverage to browse supported venues and their access tiers.
Read Example Notebooks if you want a notebook workflow.

Getting Started

SDKs

Data Schemas

Reference

Resources

Prerequisites

Use Polaris with an agent

Install and run Polaris

Prefer the API instead?

Next steps

​Prerequisites

​Use Polaris with an agent

​Install and run Polaris

​Add sign-in when you need it

​Prefer the API instead?

​Next steps

Prerequisites

Use Polaris with an agent

Install and run Polaris

Add sign-in when you need it

Prefer the API instead?

Next steps