--- title: "List all active symbols" method: GET path: "/v1/symbols/{exchange_id}/active" tags: ["Metadata"] --- # List all active symbols `GET /v1/symbols/{exchange_id}/active` 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. Type | `symbol_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) Type | Name | Description -------- | - | ----------- SPOT | FX Spot | Agreement to exchange one asset for another one *(e.g. Buy BTC for USD)* FUTURES | Futures contract | FX Spot derivative contract where traders agree to trade fx spot at predetermined future time OPTION | Option contract | FX Spot derivative contract where traders agree to trade right to require buy or sell of fx spot at agreed price on exercise date PERPETUAL | Perpetual contract | FX Spot derivative contract where traders agree to trade fx spot continously without predetermined future delivery time DEPLOYER_PERPETUAL | Deployer Perpetual contract | Perpetual contract for user-deployed markets *(e.g. Hyperliquid user-deployed perpetuals)* INDEX | Index | Statistical composite that measures changes in the economy or markets. CREDIT | Credit/Funding | Margin funding contract. Order book displays lending offers and borrow bids. Price represents the daily rate. CONTRACT | Contract | Represents other types of financial instruments *(e.g. spreads, interest rate swap)* OPTION_COMBO | Option Combo | Multi-leg option strategy combining two or more option positions *(e.g. put spread, protective collar)* FUTURE_COMBO | Future Combo | Multi-leg futures calendar spread combining two futures positions *(e.g. futures vs perpetual)* ### Additional output variables for `symbol_type = INDEX` Variable | Description --------- | ----------- index_id | Index identifier index_display_name | Human readable name of the index *(optional)* index_display_description | Description of the index *(optional)* ### Additional output variables for `symbol_type = FUTURES` Variable | Description --------- | ----------- future_delivery_time | Predetermined time of futures contract delivery date in ISO 8601 future_contract_unit | Contact size *(eg. 10 BTC if `future_contract_unit` = `10` and `future_contract_unit_asset` = `BTC`)* future_contract_unit_asset | Identifier of the asset used to denominate the contract unit ### Additional output variables for `symbol_type = PERPETUAL` Variable | Description --------- | ----------- future_contract_unit | Contact size *(eg. 10 BTC if `future_contract_unit` = `10` and `future_contract_unit_asset` = `BTC`)* future_contract_unit_asset | Identifier of the asset used to denominate the contract unit ### Additional output variables for `symbol_type = DEPLOYER_PERPETUAL` Variable | Description --------- | ----------- future_contract_unit | Contact size *(eg. 10 BTC if `future_contract_unit` = `10` and `future_contract_unit_asset` = `BTC`)* future_contract_unit_asset | Identifier of the asset used to denominate the contract unit ### Additional output variables for `symbol_type = OPTION` Variable | Description --------- | ----------- option_type_is_call | Boolean value representing option type. `true` for Call options, `false` for Put options option_strike_price | Price at which option contract can be exercised option_contract_unit | Base asset amount of underlying spot which single option represents option_exercise_style | Option exercise style. Can be `EUROPEAN` or `AMERICAN` option_expiration_time | Option contract expiration time in ISO 8601 ### Additional output variables for `symbol_type = CONTRACT` Variable | Description --------- | ----------- contract_delivery_time | Predetermined time of contract delivery date in ISO 8601 contract_unit | Contact size *(eg. 10 BTC if `contract_unit` = `10` and `contract_unit_asset` = `BTC`)* contract_unit_asset | Identifier of the asset used to denominate the contract unit contract_id | Identifier of contract by the exchange ## Path parameters - `exchange_id` string, required ## Query parameters - `filter_symbol_id` string - `filter_asset_id` string ## Response `200` successful operation - MarketDataMetadataSymbol[] - `symbol_id` string, nullable — The symbol identifier. - `exchange_id` string, nullable — The exchange identifier. - `symbol_type` string, nullable — The symbol type. - `asset_id_base` string, nullable — The base asset identifier. - `asset_id_quote` string, nullable — The quote asset identifier. - `asset_id_unit` string, nullable — The unit asset identifier. - `future_contract_unit` number, double, nullable — The contract unit for futures. - `future_contract_unit_asset` string, nullable — The asset used as the unit for futures contract. - `future_delivery_time` string, date-time, nullable — The future delivery time for futures contract. - `option_type_is_call` boolean, nullable — Indicates whether the option type is a call. - `option_strike_price` number, double, nullable — The strike price for options. - `option_contract_unit` number, double, nullable — The contract unit for options. - `option_exercise_style` string, nullable — The exercise style for options. Possible values: AMERICAN, ASIAN, BARRIER, BERMUDAN, BINARY, EUROPEAN, EXOTIC. - `option_expiration_time` string, date-time, nullable — The expiration time for options. - `contract_delivery_time` string, date-time, nullable — The delivery time for contracts. - `contract_unit` number, double, nullable — The contract unit for contracts. - `contract_unit_asset` string, nullable — The asset used as the unit for contracts. - `contract_id` string, nullable — The contract identifier. - `contract_display_name` string, nullable — The display name of the contract. - `contract_display_description` string, nullable — The display description of the contract. - `data_start` string, nullable - `data_end` string, nullable - `data_quote_start` string, date-time, nullable — The start date of quote data. - `data_quote_end` string, date-time, nullable — The end date of quote data. - `data_orderbook_start` string, date-time, nullable — The start date of order book data. - `data_orderbook_end` string, date-time, nullable — The end date of order book data. - `data_trade_start` string, date-time, nullable — The start date of trade data. - `data_trade_end` string, date-time, nullable — The end date of trade data. - `index_id` string, nullable — The index identifier. - `index_display_name` string, nullable — The display name of the index. - `index_display_description` string, nullable — The display description of the index. - `volume_1hrs` number, double, nullable — The volume in the last 1 hour. - `volume_1hrs_usd` number, double, nullable — The volume in USD in the last 1 hour. - `volume_1day` number, double, nullable — The volume in the last 1 day. - `volume_1day_usd` number, double, nullable — The volume in USD in the last 1 day. - `volume_1mth` number, double, nullable — The volume in the last 1 month. - `volume_1mth_usd` number, double, nullable — The volume in USD in the last 1 month. - `price` number, double, nullable — The price. - `symbol_id_exchange` string, nullable — The symbol identifier in the exchange. - `asset_id_base_exchange` string, nullable — The base asset identifier in the exchange. - `asset_id_quote_exchange` string, nullable — The quote asset identifier in the exchange. - `price_precision` number, double, nullable — The price precision. - `size_precision` number, double, nullable — The size precision. - `raw_kvp` object, nullable — Key Value Pair store with raw data from the data source. - `future_is_inverse` boolean, nullable — Indicates whether the futures contract is inverse (coin-margined). - `future_is_quanto` boolean, nullable — Indicates whether the futures contract is quanto. - `volume_to_usd` number, double, nullable — Volume unit in USD. - `option_barrier_up_price` number, double, nullable — The up barrier price for barrier options. - `option_barrier_up_type` string, nullable — The up barrier type for barrier options. Possible values: EXPIRATION, IN, OUT. - `option_barrier_down_price` number, double, nullable — The down barrier price for barrier options. - `option_barrier_down_type` string, nullable — The down barrier type for barrier options. Possible values: EXPIRATION, IN, OUT. - `symbol_id_int` integer, nullable — The symbol identifier in integer immutable format, used to correlate data across different APIs. --- [API](https://skmtc.net/coinapi/apis/coinapi-market-data-rest-api.md) · [All operations](https://skmtc.net/coinapi/apis/coinapi-market-data-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/coinapi/coinapi-market-data-rest-api/versions/805496271c56/schema)