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.

Not every date in available_dates is ready for simulation. Only dates where status = "complete" and stage = "model_calibration" have a fully calibrated agent model. Submitting a job with any other date will fail. Always filter before using a date as cal_date.

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["status"] == "complete" and d["stage"] == "model_calibration"
    ]
    if valid_dates:
        print(f"{sym['name']} ({sym['symbol_name']}): {valid_dates}")

Response fields

Symbol object

FieldTypeDescription
namestrSymbol ticker (e.g., 700.HK, 9999.HK)
symbol_namestrCompany/symbol name (e.g., TENCENT, NTES-S)
exchangestrExchange code (e.g., HKEX.Securities)
instrument_typestrType of instrument (equity, derivative)
currencystrTrading currency (e.g., HKD)
tick_sizefloatMinimum price increment
lot_sizeintMinimum order size
available_dateslistPer-date calibration records (see below)
avg_number_of_msgsfloatAverage message count per day
avg_volume_tradedfloatAverage daily volume

Date object (each item in available_dates)

FieldTypeDescription
datestrCalibration date in YYYY-MM-DD format
statusstrPipeline status — only "complete" is ready for simulation
stagestrPipeline stage — only "model_calibration" is ready for simulation
number_of_msgsintNumber of order book messages on this date
volume_tradedfloatTotal volume traded on this date
reference_pricefloatReference price used for calibration

Example response

json
[
  {
    "name": "700.HK",
    "symbol_name": "TENCENT",
    "exchange": "HKEX.Securities",
    "instrument_type": "equity",
    "currency": "HKD",
    "tick_size": 0.5,
    "lot_size": 100,
    "available_dates": [
      {
        "date": "2025-09-01",
        "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
  }
]