Available symbols

Discover available symbols and their configuration through the Python SDK.

Use client.data.get_available_symbols() to retrieve all configured symbols with their available dates, trading parameters, and volume statistics. It also accepts optional filters, so you can ask for one symbol, one exchange, or one date instead of the whole catalog.

Get available symbols

python

symbols = client.data.get_available_symbols()

# Only use dates that are fully calibrated
for sym in symbols:
    valid_dates = [
        d["date"] for d in sym["available_dates"]
        if d.get("status") == "complete" and d.get("stage") == "model_calibration"
    ]
    if valid_dates:
        print(f"{sym['name']} ({sym['symbol_name']}): {valid_dates}")

Filtering

Called with no arguments the method returns the whole catalog, which is large. Pass any of the following to narrow it server-side:

Argument	Type	Description
symbol	str	Exact ticker, e.g. "700.HK" — not a prefix or substring match
exchange	str	Exchange protocol, e.g. "hkex_securities"
provider	str	Data provider, e.g. "omd" or "bmll"
date	str	Calibration date "YYYY-MM-DD" — keeps only symbols calibrated on it
limit	int	Maximum symbols to return (1–1000)
offset	int	Symbols to skip, for paging alongside limit

python

# Which dates is this symbol already calibrated for?
tencent = client.data.get_available_symbols(symbol="700.HK")
print([d["date"] for d in tencent[0]["available_dates"]])

# Which symbols are ready on a particular date?
ready = client.data.get_available_symbols(date="2025-09-02")
print([s["name"] for s in ready])

# Page through one exchange
page = client.data.get_available_symbols(exchange="hkex_securities", limit=50)

Filtering by date also narrows each symbol's available_dates to that date, so avg_number_of_msgs and avg_volume_traded then describe that date alone rather than the symbol's whole history.

The same ticker can appear more than once, sourced from different providers — and those entries carry different dates and different tick sizes. Tencent, for example, exists as 700.HK from omd and as 700 from bmll. Treat (name, provider, exchange) as the identity of a row, not name on its own, and pass provider alongside symbol when you need a specific one.

Response fields

Symbol object

Field	Type	Description
name	str	Symbol ticker (e.g., 700.HK, 9999.HK)
symbol_name	str	Company/symbol name (e.g., TENCENT, NTES-S) — may be null
provider	str	Data provider the row was sourced from (e.g., omd, bmll)
exchange	str	Exchange code (e.g., HKEX.Securities)
instrument_type	str	Type of instrument (equity, derivative)
currency	str	Trading currency (e.g., HKD)
tick_size	float	Minimum price increment
lot_size	int	Minimum order size
available_dates	list	Per-date calibration records (see below)
avg_number_of_msgs	float	Average message count per day
avg_volume_traded	float	Average daily volume

Date object (each item in available_dates)

Field	Type	Description
date	str	Calibration date in YYYY-MM-DD format
status	str	Pipeline status — only "complete" is ready for simulation
stage	str	Pipeline stage — only "model_calibration" is ready for simulation
number_of_msgs	int	Number of order book messages on this date
volume_traded	float	Total volume traded on this date
reference_price	float	Reference price used for calibration

Example response

json

[
  {
    "name": "700.HK",
    "symbol_name": "TENCENT",
    "provider": "omd",
    "exchange": "HKEX.Securities",
    "instrument_type": "equity",
    "currency": "HKD",
    "tick_size": 0.5,
    "lot_size": 100,
    "available_dates": [
      {
        "date": "2025-09-02",
        "status": "complete",
        "stage": "model_calibration",
        "number_of_msgs": 868188,
        "volume_traded": 478765.11,
        "reference_price": 606.0
      },
      {
        "date": "2025-09-02",
        "status": "complete",
        "stage": "model_calibration",
        "number_of_msgs": 863274,
        "volume_traded": 444244.71,
        "reference_price": 605.0
      }
    ],
    "avg_number_of_msgs": 288577.0,
    "avg_volume_traded": 153834.97
  }
]

Simulations→