How does the Object table and JSON output of CoinAPI crypto exchange market API work?

In this article, I will clarify the object table and JSON output specific to the CoinAPI crypto exchange market API. I will cover what information is included in each output format, as well as any notable differences between the two. It is important for developers to understand the structure and contents of the object table and JSON output in order to effectively use the data provided by the CoinAPI API.

API Object and Description Table

1. exchange_id: A unique identifier for the exchange provided by CoinAPI.

2. website: The website address for the exchange.

3. name: The display name of the exchange.

4. data_start: The date of the first data point available for this exchange.

5. data_end: The date of the last data point available for this exchange.

6. data_quote_start: The date and time of the first quote available for this exchange.

7. data_quote_end: The date and time of the last quote available for this exchange.

8. data_orderbook_start: The date and time of the first order book available for this exchange.

9. data_orderbook_end: The date and time of the last order book available for this exchange.

10. data_trade_start: The date and time of the first trade available for this exchange.

11. data_trade_end: The date and time of the last trade available for this exchange.

12. data_symbols_count: The total number of symbols available for this exchange.

13. volume_1hrs_usd: The total volume in USD of all symbols from the last 1 hour rolling period.

14. volume_1day_usd: The total volume in USD of all symbols from the last 1 day rolling period.

15. volume_1mth_usd: The total volume in USD of all symbols from the last 1 month rolling period.

The information in the table is useful because it provides a detailed overview of the data available for a particular crypto exchange on CoinAPI. By knowing the dates of the first and last data points, quotes, order books, and trades, developers can understand the range of data that is available for analysis. The exchange identifier and display name allow developers to easily identify which exchange they are working with. The website address and symbol count provide additional context and background information about the exchange. Finally, the rolling volume data in USD gives developers an idea of the trading activity on the exchange over various time periods. All of these details can be valuable when working with data from the CoinAPI crypto exchange market API.

JSON REST Output

This JSON output is an array of two objects, each representing a different crypto exchange. The first object has the exchange identifier "OKCOIN_CNY", a website at "okcoin.cn", and a display name of "OKCoin CNY". The available data for this exchange ranges from June 12, 2013 to March 9, 2018, and includes quotes, order books, and trades. There are 2 symbols available for this exchange, and the rolling volume data in USD for the last 1 hour, 1 day, and 1 month is 0.0. The second object has similar information for the exchange with the identifier "HUOBI", a website at "huobi.com", and a display name of "Huobi (HBUS)". The available data for this exchange ranges from March 29, 2015 to November 3, 2019, and includes quotes, order books, and trades. There are 403 symbols available for this exchange, and the rolling volume data in USD for the last 1 hour, 1 day, and 1 month is 1605.80, 59957.44, and 1259508.43 respectively.

[
{
"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
}
]

Ending words

Today, we have discussed the object table and JSON output of the CoinAPI crypto exchange market API. The object table lists the various objects available in the API, including the exchange identifier, website, display name, and data ranges for quotes, order books, and trades, as well as the number of symbols and rolling volume data in USD. The JSON output presents this information in a structured format, with each exchange represented as an object in an array. Understanding the structure and contents of the object table and JSON output is important for developers working with the CoinAPI API.

Reference

To access the CoinAPI crypto exchange market API, you can request access through the third party data marketplace of Worldindata. Worldindata is a platform that offers access to a wide variety of data sources, including the CoinAPI API. By signing up for an account and subscribing to the CoinAPI API through Worldindata, you can gain access to the data and resources provided by CoinAPI. This can be a convenient way to access the CoinAPI API, as it allows you to manage your subscription and payments through a single platform. Please note that you may need to meet certain requirements and agree to the terms of service in order to use the CoinAPI API through Worldindata.