Metadata

List all asset icons GET

Gets the list of icons (of the given size) for all the assets.

var client = new RestClient("https://rest.coinapi.io/v1/assets/icons/32");
var request = new RestRequest(Method.GET);
request.AddHeader("X-CoinAPI-Key", "73034021-THIS-IS-SAMPLE-KEY");
IRestResponse response = client.Execute(request);

The above command returns JSON structured like this:

[
  {
    "asset_id": "BTC",
    "url": "https://s3.eu-central-1.amazonaws.com/bbxt-static-icons/type-id/png_16/f231d7382689406f9a50dde841418c64.png"
  },
  {
    "asset_id": "ETH",
    "url": "https://s3.eu-central-1.amazonaws.com/bbxt-static-icons/type-id/png_16/04836ff3bc4d4d95820e0155594dca86.png"
  },
  {
    "asset_id": "USD",
    "url": "https://s3.eu-central-1.amazonaws.com/bbxt-static-icons/type-id/png_16/4873707f25fe4de3b4bca6fa5c631011.png"
  }
]

HTTP Request

GET /v1/assets/icons/{iconSize}

Output variables

Variable	Description
asset_id	Our asset identifier.
url	The url of icon.

List all symbols GET

Get detailed list of all symbols.

curl https://rest.coinapi.io/v1/symbols \
--request GET
--header "X-CoinAPI-Key: 73034021-THIS-IS-SAMPLE-KEY"

The above command returns JSON structured like this:

[
  {
    "symbol_id": "KRAKENFTS_PERP_BTC_USD",
    "exchange_id": "KRAKENFTS",
    "symbol_type": "PERPETUAL",
    "asset_id_base": "BTC",
    "asset_id_quote": "USD",
    "asset_id_unit": "USD",
    "future_contract_unit": 1.000000000,
    "future_contract_unit_asset": "USD",
    "data_start": "2019-10-30",
    "data_end": "2021-03-03",
    "data_quote_start": "2019-10-30T16:53:10.3262317Z",
    "data_quote_end": "2021-03-03T13:51:45.6970000Z",
    "data_orderbook_start": "2019-10-30T16:53:10.3262317Z",
    "data_orderbook_end": "2020-08-05T14:37:32.0080000Z",
    "data_trade_start": "2019-10-30T16:38:52.1620000Z",
    "data_trade_end": "2021-03-03T13:46:25.7810000Z",
    "volume_1hrs": 22897091.000000000,
    "volume_1hrs_usd": 22897091.00,
    "volume_1day": 459390289.000000000,
    "volume_1day_usd": 459390289.00,
    "volume_1mth": 12875674995.000000000,
    "volume_1mth_usd": 12875674995.00,
    "price": 51266,
    "symbol_id_exchange": "pi_xbtusd",
    "asset_id_base_exchange": "XBT",
    "asset_id_quote_exchange": "USD",
    "price_precision": 0.100000000,
    "size_precision": 1.000000000
  },
  {
    "symbol_id": "POLONIEX_SPOT_LTC_USDC",
    "exchange_id": "POLONIEX",
    "symbol_type": "SPOT",
    "asset_id_base": "LTC",
    "asset_id_quote": "USDC",
    "data_start": "2018-11-20",
    "data_end": "2021-03-01",
    "data_quote_start": "2018-11-20T15:24:58.4128803Z",
    "data_quote_end": "2021-03-01T16:07:09.3475456Z",
    "data_orderbook_start": "2018-11-20T15:24:58.4128803Z",
    "data_orderbook_end": "2020-08-05T14:37:20.2695780Z",
    "data_trade_start": "2018-11-20T15:25:38.0000000Z",
    "data_trade_end": "2021-03-01T16:03:18.0000000Z",
    "volume_1hrs": 51.686458990,
    "volume_1hrs_usd": 9036.44,
    "volume_1day": 465.568863000,
    "volume_1day_usd": 81396.28,
    "volume_1mth": 22528.276384950,
    "volume_1mth_usd": 3938661.00,
    "symbol_id_exchange": "USDC_LTC",
    "asset_id_base_exchange": "LTC",
    "asset_id_quote_exchange": "USDC",
    "price_precision": 0.000000010,
    "size_precision": 0.000000010
  }
]

HTTP Request

GET /v1/symbols?filter_symbol_id={filter_symbol_id}&filter_exchange_id={filter_exchange_id}&filter_asset_id={filter_asset_id}
GET /v1/symbols/{exchange_id}

URL Parameters

Parameter	Type	Description
filter_symbol_id	string[]	Comma or semicolon delimited parts of symbol identifier used to filter response. (optional, eg. `BITSTAMP_` or `BINANCE_SPOT_`)

Common output variables

Variable	Description
symbol_id	Our symbol identifier, see table below for format description.
exchange_id	Our identifier of the exchange where symbol is traded.
symbol_type	Type of the symbol. Valid values: `SPOT` `FUTURES` `OPTION` `PERPETUAL` `INDEX` `CREDIT` `CONTRACT`
asset_id_base	FX Spot base asset identifier, for derivatives it's contact underlying (e.g. `BTC` for BTC/USD)
asset_id_quote	FX Spot quote asset identifier, for derivatives it's contract underlying (e.g. `USD` for BTC/USD)
asset_id_unit	Identifier of the symbol unit asset used to denominate: transactions and order books volume (optional, if not provided then data is denominated in `asset_id_base`)
data_start	Date of the first data point
data_end	Date of the last data point
data_quote_start	The date and time of first quote.
data_quote_end	The date and time of last quote.
data_orderbook_start	The date and time of first order book.
data_orderbook_end	The date and time of last order book.
data_trade_start	The date and time of first trade.
data_trade_end	The date and time of last trade.
volume_1hrs	Volume denominated in symbol unit asset from last 1 hour rolling period.
volume_1hrs_usd	Volume denominated in USD from last 1 hour rolling period.
volume_1day	Volume denominated in symbol unit asset from last 1 day rolling period.
volume_1day_usd	Volume denominated in USD from last 1 day rolling period.
volume_1mth	Volume denominated in symbol unit asset from last 1 month rolling period.
volume_1mth_usd	Volume denominated in USD from last 1 month rolling period.
price	The current price.
symbol_id_exchange	Exchange symbol identifier.
asset_id_base_exchange	Exchange FX Spot base asset identifier
asset_id_quote_exchange	Exchange FX Spot quote asset identifier
price_precision	Current order price precision observed (a posteriori) from the market data or known (a priori) from the data source metadata.
size_precision	Current order size precision observed (a posteriori) from the market data or known (a priori) from the data source metadata.

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}`
INDEX	`{exchange_id}_IDX_{index_id}`
CREDIT	`{exchange_id}_CRE_{asset_id_base}`
CONTACT	`{exchange_id}_COT_{contract_id}`

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

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

List all assets GET

curl https://rest.coinapi.io/v1/assets \
  --request GET
  --header "X-CoinAPI-Key: 73034021-THIS-IS-SAMPLE-KEY"

The above command returns JSON structured like this:

[
  {
    "asset_id": "BTC",
    "name": "Bitcoin",
    "type_is_crypto": 1,
    "data_start": "2010-07-17",
    "data_end": "2019-11-03",
    "data_quote_start": "2014-02-24T17:43:05.0000000Z",
    "data_quote_end": "2019-11-03T17:55:07.6724523Z",
    "data_orderbook_start": "2014-02-24T17:43:05.0000000Z",
    "data_orderbook_end": "2019-11-03T17:55:17.8592413Z",
    "data_trade_start": "2010-07-17T23:09:17.0000000Z",
    "data_trade_end": "2019-11-03T17:55:11.8220000Z",
    "data_symbols_count": 22711,
    "volume_1hrs_usd": 102894431436.49,
    "volume_1day_usd": 2086392323256.16,
    "volume_1mth_usd": 57929168359984.54,
    "price_usd": 9166.207274778093436220194944
  },
  {
    "asset_id": "USD",
    "name": "US Dollar",
    "type_is_crypto": 0,
    "data_start": "2010-07-17",
    "data_end": "2019-11-03",
    "data_quote_start": "2014-02-24T17:43:05.0000000Z",
    "data_quote_end": "2019-11-03T17:54:49.3807706Z",
    "data_orderbook_start": "2014-02-24T17:43:05.0000000Z",
    "data_orderbook_end": "2019-11-03T17:55:13.1863931Z",
    "data_trade_start": "2010-07-17T23:09:17.0000000Z",
    "data_trade_end": "2019-11-03T17:55:07.7870000Z",
    "data_symbols_count": 10728,
    "volume_1hrs_usd": 9466454016.52,
    "volume_1day_usd": 221580758173.49,
    "volume_1mth_usd": 11816685174661.70,
    "price_usd": 1.0
  }
]

Get detailed list of assets.

HTTP Request

GET /v1/assets
GET /v1/assets/{asset_id}
GET /v1/assets?filter_asset_id={filter_asset_id}

URL Parameters

Parameter	Type	Description
filter_asset_id	string[]	Comma or semicolon delimited asset identifiers used to filter response. (optional, eg. `BTC;ETH`)

Output variables

Variable	Description
asset_id	Our asset identifier. Superset of the ISO 4217 currency codes standard.
name	Display name of the asset.
type_is_crypto	Boolean value transported as integer; `1` for cryptocurrency assets, `0` otherwise.
data_quote_start	The date and time of first quote.
data_quote_end	The date and time for last quote.
data_orderbook_start	The date and time for first order book.
data_orderbook_end	The date and time for last order book.
data_trade_start	The date and time for first trade.
data_trade_end	The date and time for last trade.
data_quote_count	The count of quotes.
data_trade_count	The count of trades.
data_symbols_count	The count of symbols for given asset.
volume_1hrs_usd	The usd volume of all symbols associated with this asset from last 1 hour rolling period.
volume_1day_usd	The usd volume of all symbols associated with this asset from last 1 day rolling period.
volume_1mth_usd	The usd volume of all symbols associated with this asset from last 1 month rolling period.
price_usd	The actual usd price.

List all exchange icons GET

var client = new RestClient("https://rest.coinapi.io/v1/exchanges/icons/32");
var request = new RestRequest(Method.GET);
request.AddHeader("X-CoinAPI-Key", "73034021-THIS-IS-SAMPLE-KEY");
IRestResponse response = client.Execute(request);

[
  {
    "exchange_id": "CHAINCE",
    "url": "https://s3.eu-central-1.amazonaws.com/bbxt-static-icons/type-id/png_16/204e55dd8dab4a0d823c21f04be6be4b.png"
  },
  {
    "exchange_id": "BILAXY",
    "url": "https://s3.eu-central-1.amazonaws.com/bbxt-static-icons/type-id/png_16/4958c92dbddd4936b1f655e5063dc782.png"
  },
  {
    "exchange_id": "BCOINSG",
    "url": "https://s3.eu-central-1.amazonaws.com/bbxt-static-icons/type-id/png_16/b7c77041cdef4f359b4044b2d73c7741.png"
  }
]

Gets the list of icons (of the given size) for all the exchanges.

HTTP Request

GET /v1/exchanges/icons/{iconSize}

Output variables

Variable	Description
exchange_id	Our exchange identifier.
url	The url of icon.

List all exchanges GET

curl https://rest.coinapi.io/v1/exchanges \
  --request GET 
  --header "X-CoinAPI-Key: 73034021-THIS-IS-SAMPLE-KEY"

The above command returns JSON structured like this:

[
  {
    "exchange_id": "OKCOIN_CNY",
    "website": "https://www.okcoin.cn/",
    "name": "OKCoin CNY",
    "data_start": "2013-06-12",
    "data_end": "2018-03-09",
    "data_quote_start": "2015-02-15T12:53:50.3430000Z",
    "data_quote_end": "2018-03-09T23:34:52.5800000Z",
    "data_orderbook_start": "2015-02-15T12:53:50.3430000Z",
    "data_orderbook_end": "2018-03-09T23:34:52.5800000Z",
    "data_trade_start": "2013-06-12T14:24:24.0000000Z",
    "data_trade_end": "2017-11-01T16:30:39.7077259Z",
    "data_symbols_count": 2,
    "volume_1hrs_usd": 0.0,
    "volume_1day_usd": 0.0,
    "volume_1mth_usd": 0.0
  },
  {
    "exchange_id": "HUOBI",
    "website": "https://www.huobi.com/",
    "name": "Huobi (HBUS)",
    "data_start": "2015-03-29",
    "data_end": "2019-11-03",
    "data_quote_start": "2015-03-29T21:46:06.2630000Z",
    "data_quote_end": "2019-11-03T18:22:29.1837496Z",
    "data_orderbook_start": "2015-03-29T21:46:06.2630000Z",
    "data_orderbook_end": "2019-11-03T18:23:53.2859878Z",
    "data_trade_start": "2015-03-29T21:46:08.7030000Z",
    "data_trade_end": "2019-11-03T18:21:48.2770000Z",
    "data_symbols_count": 403,
    "volume_1hrs_usd": 1605.80,
    "volume_1day_usd": 59957.44,
    "volume_1mth_usd": 1259508.43
  }
]

Get a detailed list of exchanges provided by the system.

HTTP Request

GET /v1/exchanges
GET /v1/exchanges/{exchange_id}
GET /v1/exchanges?filter_exchange_id={filter_exchange_id}

URL Parameters

Parameter	Type	Description
filter_exchange_id	string[]	Comma or semicolon delimited exchange identifiers used to filter response. (optional, eg. `BITSTAMP;GEMINI`)

Output variables

Variable	Description
exchange_id	Our exchange identifier
website	Exchange website address
name	Display name of the exchange
data_start	The date of first data point.
data_end	The date of last data point.
data_quote_start	The date and time of first quote.
data_quote_end	The date and time of last quote.
data_orderbook_start	The date and time of first order book.
data_orderbook_end	The date and time of last order book.
data_trade_start	The date and time of first trade.
data_trade_end	The date and time of last trade.
data_symbols_count	The count of all symbols within exchange.
volume_1hrs_usd	The usd volume of all symbols from last 1 hour rolling period.
volume_1day_usd	The usd volume of all symbols from last 1 day rolling period.
volume_1mth_usd	The usd volume of all symbols from last 1 month rolling period.

Exchange Rates Metrics

Was this section helpful?

Metadata

List all asset icons GET

HTTP Request

Output variables

List all symbols GET

HTTP Request

URL Parameters

Common output variables

Symbol identifier

Symbol types list (enumeration of symbol_type output variable)

Additional output variables for symbol_type = INDEX

Additional output variables for symbol_type = FUTURES

Additional output variables for symbol_type = PERPETUAL

Additional output variables for symbol_type = OPTION

Additional output variables for symbol_type = CONTRACT

List all assets GET

HTTP Request

URL Parameters

Output variables

List all exchange icons GET

HTTP Request

Output variables

List all exchanges GET

HTTP Request

URL Parameters

Output variables

Symbol types list (enumeration of `symbol_type` output variable)

Additional output variables for `symbol_type = INDEX`

Additional output variables for `symbol_type = FUTURES`

Additional output variables for `symbol_type = PERPETUAL`

Additional output variables for `symbol_type = OPTION`

Additional output variables for `symbol_type = CONTRACT`