Skip to content

Latest commit

 

History

History
53 lines (49 loc) · 12.9 KB

v1symbol.md

File metadata and controls

53 lines (49 loc) · 12.9 KB

V1Symbol

Represents a symbol data model.

Fields

Field Type Required Description
symbol_id Optional[str] ➖ The symbol identifier.
exchange_id Optional[str] ➖ The exchange identifier.
symbol_type Optional[str] ➖ The symbol type.
asset_id_base Optional[str] ➖ The base asset identifier.
asset_id_quote Optional[str] ➖ The quote asset identifier.
asset_id_unit Optional[str] ➖ The unit asset identifier.
future_contract_unit Optional[float] ➖ The contract unit for futures.
future_contract_unit_asset Optional[str] ➖ The asset used as the unit for futures contract.
future_delivery_time date ➖ The future delivery time for futures contract.
option_type_is_call Optional[bool] ➖ Indicates whether the option type is a call.
option_strike_price Optional[float] ➖ The strike price for options.
option_contract_unit Optional[float] ➖ The contract unit for options.
option_exercise_style Optional[str] ➖ The exercise style for options.
option_expiration_time date ➖ The expiration time for options.
contract_delivery_time date ➖ The delivery time for contracts.
contract_unit Optional[float] ➖ The contract unit for contracts.
contract_unit_asset Optional[str] ➖ The asset used as the unit for contracts.
contract_id Optional[str] ➖ The contract identifier.
contract_display_name Optional[str] ➖ The display name of the contract.
contract_display_description Optional[str] ➖ The display description of the contract.
data_start Optional[str] ➖ N/A
data_end Optional[str] ➖ N/A
data_quote_start date ➖ The start date of quote data.
data_quote_end date ➖ The end date of quote data.
data_orderbook_start date ➖ The start date of order book data.
data_orderbook_end date ➖ The end date of order book data.
data_trade_start date ➖ The start date of trade data.
data_trade_end date ➖ The end date of trade data.
index_id Optional[str] ➖ The index identifier.
index_display_name Optional[str] ➖ The display name of the index.
index_display_description Optional[str] ➖ The display description of the index.
volume_1hrs Optional[float] ➖ The volume in the last 1 hour.
volume_1hrs_usd Optional[float] ➖ The volume in USD in the last 1 hour.
volume_1day Optional[float] ➖ The volume in the last 1 day.
volume_1day_usd Optional[float] ➖ The volume in USD in the last 1 day.
volume_1mth Optional[float] ➖ The volume in the last 1 month.
volume_1mth_usd Optional[float] ➖ The volume in USD in the last 1 month.
price Optional[float] ➖ The price.
symbol_id_exchange Optional[str] ➖ The symbol identifier in the exchange.
asset_id_base_exchange Optional[str] ➖ The base asset identifier in the exchange.
asset_id_quote_exchange Optional[str] ➖ The quote asset identifier in the exchange.
price_precision Optional[float] ➖ The price precision.
size_precision Optional[float] ➖ The size precision.
raw_kvp Dict[str, str] ➖ Not normalized raw kvp data.