What Polaris is
Use Polaris when you need to:- Discover which venues, markets, and time ranges are available right now.
- Download historical snapshot files for bulk research and ingestion.
- Query recent trades, events, and OHLCV bars over REST.
- Inspect raw venue-native payloads when replayability matters.
- Reuse the same access model across the CLI, REST API, and SDKs.
Why teams use Polaris
Most market data work breaks down at the venue layer. Every venue has its own identifiers, timestamp conventions, payload shapes, and quirks around history. Polaris gives you one place to:- Browse coverage before you build.
- Start with public access, then add authentication only when you need more.
- Choose the right surface for the job: CLI, snapshots, REST, raw payloads, or SDKs.
- Move between venues without rewriting your entire parsing pipeline.
Choose your path
Quickstart
Install the Polaris CLI, open the TUI, and download your first dataset.
Market Coverage
Browse supported venues, preview and open access tiers, and example market IDs.
Authentication
Learn when public access is enough and when bearer auth actually matters.
Catalog
Discover supported venues, exact market IDs, and available time bounds.
Snapshots
List and download canonical historical files for standardized datasets.
Python SDK
Use
polaris_data to discover markets, fetch datasets, and replay data locally.Recommended first path
- Start with Quickstart if you want the fastest route to first data.
- Open Market Coverage to browse supported venues and their access tiers.
- Use Catalog to confirm exact
sourceandmarketpairs. - Branch into Snapshots, the API Overview, or the Python SDK once you know the workflow you need.
Typical workflows
- Use the CLI when you want the fastest path to browsing and downloading data.
- Use snapshots when you need bulk historical files for research, backfills, or ingestion.
- Use REST when you want recent trades, events, or OHLCV bars on demand.
- Use raw payloads when you need venue-native fields for replay or validation.
- Use the Python SDK when you want a notebook or local analysis workflow.
Support and resources
- Use Market Coverage for a live high-level view of currently listed venues.
- Use Example Notebooks if you want a notebook-first Python workflow.
- Use Authentication when you need explicit historical ranges or access beyond the public window.