v2

latestOpenAPI 3.0.4MIT License2026-08-015029332.0 KB
Metadata

List all active symbols

Retrieves all currently active (listed) symbols, with optional filtering.

:::info "price_precision" and "size_precision" are data precisions and are not always the same precisions used for trading eg. for the "BINANCE" exchanges. :::

:::info You should not assume that the market data will be always within the resolution provided by the "price_precision" and "size_precision". The fact that the precision values can be derived from a posterior implies the fact that this data could be delayed, also it can be changed by the data source without notice and we will immediately deliver data with the new precision while could not update the precision values in this endpoint immediately. :::

Symbol identifier

Our symbol identifier is created using a pattern that depends on symbol type.

Typesymbol_id pattern
SPOT{exchange_id}_SPOT_{asset_id_base}_{asset_id_quote}
FUTURES{exchange_id}_FTS_{asset_id_base}_{asset_id_quote}_{YYMMDD of future_delivery_time}
OPTION{exchange_id}_OPT_{asset_id_base}_{asset_id_quote}_{YYMMDD of option_expiration_time}_{option_strike_price}_{option_type_is_call as C/P}
PERPETUAL{exchange_id}_PERP_{asset_id_base}_{asset_id_quote}
DEPLOYER_PERPETUAL{exchange_id}_DPERP_{deployer_symbol}_{asset_id_quote}
INDEX{exchange_id}_IDX_{index_id}
CREDIT{exchange_id}_CRE_{asset_id_base}
CONTACT{exchange_id}_COT_{contract_id}
OPTION_COMBO{exchange_id}_OPTCMB_{exchange_symbol_id}
FUTURE_COMBO{exchange_id}_FTSCMB_{exchange_symbol_id}

:::info In the unlikely event when the "symbol_id" for more than one market is the same. We will append the additional term (prefixed with the "_") at the end of the duplicated identifiers to differentiate them. :::info

Symbol types list (enumeration of symbol_type output variable)

TypeNameDescription
SPOTFX SpotAgreement to exchange one asset for another one (e.g. Buy BTC for USD)
FUTURESFutures contractFX Spot derivative contract where traders agree to trade fx spot at predetermined future time
OPTIONOption contractFX Spot derivative contract where traders agree to trade right to require buy or sell of fx spot at agreed price on exercise date
PERPETUALPerpetual contractFX Spot derivative contract where traders agree to trade fx spot continously without predetermined future delivery time
DEPLOYER_PERPETUALDeployer Perpetual contractPerpetual contract for user-deployed markets (e.g. Hyperliquid user-deployed perpetuals)
INDEXIndexStatistical composite that measures changes in the economy or markets.
CREDITCredit/FundingMargin funding contract. Order book displays lending offers and borrow bids. Price represents the daily rate.
CONTRACTContractRepresents other types of financial instruments (e.g. spreads, interest rate swap)
OPTION_COMBOOption ComboMulti-leg option strategy combining two or more option positions (e.g. put spread, protective collar)
FUTURE_COMBOFuture ComboMulti-leg futures calendar spread combining two futures positions (e.g. futures vs perpetual)

Additional output variables for symbol_type = INDEX

VariableDescription
index_idIndex identifier
index_display_nameHuman readable name of the index (optional)
index_display_descriptionDescription of the index (optional)

Additional output variables for symbol_type = FUTURES

VariableDescription
future_delivery_timePredetermined time of futures contract delivery date in ISO 8601
future_contract_unitContact size (eg. 10 BTC if future_contract_unit = 10 and future_contract_unit_asset = BTC)
future_contract_unit_assetIdentifier of the asset used to denominate the contract unit

Additional output variables for symbol_type = PERPETUAL

VariableDescription
future_contract_unitContact size (eg. 10 BTC if future_contract_unit = 10 and future_contract_unit_asset = BTC)
future_contract_unit_assetIdentifier of the asset used to denominate the contract unit

Additional output variables for symbol_type = DEPLOYER_PERPETUAL

VariableDescription
future_contract_unitContact size (eg. 10 BTC if future_contract_unit = 10 and future_contract_unit_asset = BTC)
future_contract_unit_assetIdentifier of the asset used to denominate the contract unit

Additional output variables for symbol_type = OPTION

VariableDescription
option_type_is_callBoolean value representing option type. true for Call options, false for Put options
option_strike_pricePrice at which option contract can be exercised
option_contract_unitBase asset amount of underlying spot which single option represents
option_exercise_styleOption exercise style. Can be EUROPEAN or AMERICAN
option_expiration_timeOption contract expiration time in ISO 8601

Additional output variables for symbol_type = CONTRACT

VariableDescription
contract_delivery_timePredetermined time of contract delivery date in ISO 8601
contract_unitContact size (eg. 10 BTC if contract_unit = 10 and contract_unit_asset = BTC)
contract_unit_assetIdentifier of the asset used to denominate the contract unit
contract_idIdentifier of contract by the exchange
get/v1/symbols/{exchange_id}/active

Path parameters

exchange_idstring required

The ID of the exchange.

Query parameters

filter_symbol_idstring

Comma or semicolon delimited parts of symbol identifier used to filter response. (optional, eg. BITSTAMP_ or BINANCE_SPOT_)

filter_asset_idstring

The filter for asset ID.

Response

successful operation

symbol_idstring nullable

The symbol identifier.

exchange_idstring nullable

The exchange identifier.

symbol_typestring nullable

The symbol type.

asset_id_basestring nullable

The base asset identifier.

asset_id_quotestring nullable

The quote asset identifier.

asset_id_unitstring nullable

The unit asset identifier.

future_contract_unitnumber double nullable

The contract unit for futures.

future_contract_unit_assetstring nullable

The asset used as the unit for futures contract.

future_delivery_timestring date-time nullable

The future delivery time for futures contract.

option_type_is_callboolean nullable

Indicates whether the option type is a call.

option_strike_pricenumber double nullable

The strike price for options.

option_contract_unitnumber double nullable

The contract unit for options.

option_exercise_stylestring nullable

The exercise style for options. Possible values: AMERICAN, ASIAN, BARRIER, BERMUDAN, BINARY, EUROPEAN, EXOTIC.

option_expiration_timestring date-time nullable

The expiration time for options.

contract_delivery_timestring date-time nullable

The delivery time for contracts.

contract_unitnumber double nullable

The contract unit for contracts.

contract_unit_assetstring nullable

The asset used as the unit for contracts.

contract_idstring nullable

The contract identifier.

contract_display_namestring nullable

The display name of the contract.

contract_display_descriptionstring nullable

The display description of the contract.

data_startstring nullable
data_endstring nullable
data_quote_startstring date-time nullable

The start date of quote data.

data_quote_endstring date-time nullable

The end date of quote data.

data_orderbook_startstring date-time nullable

The start date of order book data.

data_orderbook_endstring date-time nullable

The end date of order book data.

data_trade_startstring date-time nullable

The start date of trade data.

data_trade_endstring date-time nullable

The end date of trade data.

index_idstring nullable

The index identifier.

index_display_namestring nullable

The display name of the index.

index_display_descriptionstring nullable

The display description of the index.

volume_1hrsnumber double nullable

The volume in the last 1 hour.

volume_1hrs_usdnumber double nullable

The volume in USD in the last 1 hour.

volume_1daynumber double nullable

The volume in the last 1 day.

volume_1day_usdnumber double nullable

The volume in USD in the last 1 day.

volume_1mthnumber double nullable

The volume in the last 1 month.

volume_1mth_usdnumber double nullable

The volume in USD in the last 1 month.

pricenumber double nullable

The price.

symbol_id_exchangestring nullable

The symbol identifier in the exchange.

asset_id_base_exchangestring nullable

The base asset identifier in the exchange.

asset_id_quote_exchangestring nullable

The quote asset identifier in the exchange.

price_precisionnumber double nullable

The price precision.

size_precisionnumber double nullable

The size precision.

raw_kvpobject nullable

Key Value Pair store with raw data from the data source.

future_is_inverseboolean nullable

Indicates whether the futures contract is inverse (coin-margined).

future_is_quantoboolean nullable

Indicates whether the futures contract is quanto.

volume_to_usdnumber double nullable

Volume unit in USD.

option_barrier_up_pricenumber double nullable

The up barrier price for barrier options.

option_barrier_up_typestring nullable

The up barrier type for barrier options. Possible values: EXPIRATION, IN, OUT.

option_barrier_down_pricenumber double nullable

The down barrier price for barrier options.

option_barrier_down_typestring nullable

The down barrier type for barrier options. Possible values: EXPIRATION, IN, OUT.

symbol_id_intinteger nullable

The symbol identifier in integer immutable format, used to correlate data across different APIs.