get_timeseries_fields(symbol)
Description:
Returns a list of all valid field names that can be used with the get_timeseries() function for a given instrument symbol. Useful for validating or dynamically selecting fields when building time series queries.
Function Signature:
get_timeseries_fields(symbol: str) -> tupleParameters:
| Parameter | Type | Required | Default | Description |
| symbol | str | Yes | — | A single instrument symbol (e.g., 'IBM', 'BRN 1!-ICE') to query available time series fields for. |
Return:
Returns a list of strings, where each string is a valid field name that can be passed to get_timeseries() for the given symbol.
Notes:
- This function is symbol-specific: different instruments (e.g., equities vs. commodities) may support different sets of fields.
- Common field names include:
- 'last' – Last traded price, 'volume' – Trade volume, 'open', 'high', 'low' – OHLC data
- Field names are typically lowercase, and returned in the format expected by get_timeseries().