Skip to main content

List all symbols

GET 
/v1/symbols

Retrieves all 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}
INDEX{exchange_id}_IDX_{index_id}
CREDIT{exchange_id}_CRE_{asset_id_base}
CONTACT{exchange_id}_COT_{contract_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
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)

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 = 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

Request​

Query Parameters

    filter_symbol_id string

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

    filter_exchange_id string

    The filter for exchange ID.

    filter_asset_id string

    The filter for asset ID.

Responses​

successful operation

Schema

  • Array [

    • symbol_id stringnullable

    The symbol identifier.

    exchange_id stringnullable

    The exchange identifier.

    symbol_type stringnullable

    The symbol type.

    asset_id_base stringnullable

    The base asset identifier.

    asset_id_quote stringnullable

    The quote asset identifier.

    asset_id_unit stringnullable

    The unit asset identifier.

    future_contract_unit doublenullable

    The contract unit for futures.

    future_contract_unit_asset stringnullable

    The asset used as the unit for futures contract.

    future_delivery_time date-timenullable

    The future delivery time for futures contract.

    option_type_is_call booleannullable

    Indicates whether the option type is a call.

    option_strike_price doublenullable

    The strike price for options.

    option_contract_unit doublenullable

    The contract unit for options.

    option_exercise_style stringnullable

    The exercise style for options.

    option_expiration_time date-timenullable

    The expiration time for options.

    contract_delivery_time date-timenullable

    The delivery time for contracts.

    contract_unit doublenullable

    The contract unit for contracts.

    contract_unit_asset stringnullable

    The asset used as the unit for contracts.

    contract_id stringnullable

    The contract identifier.

    contract_display_name stringnullable

    The display name of the contract.

    contract_display_description stringnullable

    The display description of the contract.

    data_start stringnullable
    data_end stringnullable
    data_quote_start date-timenullable

    The start date of quote data.

    data_quote_end date-timenullable

    The end date of quote data.

    data_orderbook_start date-timenullable

    The start date of order book data.

    data_orderbook_end date-timenullable

    The end date of order book data.

    data_trade_start date-timenullable

    The start date of trade data.

    data_trade_end date-timenullable

    The end date of trade data.

    index_id stringnullable

    The index identifier.

    index_display_name stringnullable

    The display name of the index.

    index_display_description stringnullable

    The display description of the index.

    volume_1hrs doublenullable

    The volume in the last 1 hour.

    volume_1hrs_usd doublenullable

    The volume in USD in the last 1 hour.

    volume_1day doublenullable

    The volume in the last 1 day.

    volume_1day_usd doublenullable

    The volume in USD in the last 1 day.

    volume_1mth doublenullable

    The volume in the last 1 month.

    volume_1mth_usd doublenullable

    The volume in USD in the last 1 month.

    price doublenullable

    The price.

    symbol_id_exchange stringnullable

    The symbol identifier in the exchange.

    asset_id_base_exchange stringnullable

    The base asset identifier in the exchange.

    asset_id_quote_exchange stringnullable

    The quote asset identifier in the exchange.

    price_precision doublenullable

    The price precision.

    size_precision doublenullable

    The size precision.

    raw_kvp

    object

    nullable

    Not normalized raw kvp data.

    property name* string
    volume_to_usd doublenullable

    Volume unit in USD.

  • ]

Loading...