Discover Symbols
Use the SDK's list_symbols helper to explore every exchange and dataset combination we have stored. Historical symbols stay discoverable even after an exchange delists them, as long as matching files exist in the dataset. The helper issues a cached/symbols API request and returns a sorted Python list so you can validate coverage before starting a download job.
Enumerate Exchange Coverage
Call chd.list_symbols for a quick snapshot or use the client method when you already have a configuredCryptoHFTDataClient instance. The response is cached at the edge for 24 hours, which keeps symbol discovery fast even when an exchange exposes thousands of markets.
1import cryptohftdata as chd
2
3client = chd.CryptoHFTDataClient(api_key="your-api-key-here")
4
5# Module-level helper (no client required)
6binance_spot_symbols = chd.list_symbols(chd.exchanges.BINANCE_SPOT)
7print(f"Binance spot pairs: {len(binance_spot_symbols)}")
8print("First five:", binance_spot_symbols[:5])
9
10# Client method with optional filtering
11futures_orderbook = client.list_symbols(
12 chd.exchanges.BINANCE_FUTURES,
13 data_type="orderbook",
14)
15print(f"Futures order book markets: {len(futures_orderbook)}")Filter by Dataset
Pass the optional data_type argument to narrow the results to a single dataset. This mirrors the REST API query parameter and accepts the same values shown below.
Available Filters
- orderbook — depth snapshots and incremental updates
- trades — individual executions with taker/maker side
- ticker — best bid/ask and rolling stats
- mark_price — mark/index/funding metrics for derivatives
- open_interest — outstanding contract counts and notionals
- liquidations — forced position closures with pricing details
Use Results in Workflows
Store the returned list in configuration files, iterate over it to schedule batch downloads, or cross-reference it with your existing analytics universe. Because the helper always returns sorted symbols, you get deterministic diffs when persisting discovery results to source control.