How do the Object and Description table and JSON Output of CoinAPI crypto order book API work?

In this article, I will review the object table and JSON output specifically of CoinAPI's crypto order book API. I will explain how the data is structured within these formats and provide examples to illustrate their use. This information will be useful for developers looking to utilize CoinAPI's order book data in their projects.

Object and Description of API

1. symbol_id: A unique identifier for the symbol being traded, in a format specified by CoinAPI.

2. time_exchange: The time at which the order book was recorded by the exchange.

3. time_coinapi: The time at which CoinAPI received the order book data from the exchange.

4. asks: A list of the top 20 ask levels, ordered from best (lowest) price to worst (highest) price.

5. bids: A list of the top 20 bid levels, ordered from best (highest) price to worst (lowest) price.

6. price: The price of a particular bid or ask level.

7. size: The volume of the symbol being traded at a particular bid or ask level, in the base amount (e.g. the base currency if the symbol is a currency pair).

The information in the table is useful for developers who are working with CoinAPI's crypto order book data because it provides a clear and concise overview of the different objects that are included in the data. By understanding the meaning of each object and how it is structured, developers can more easily access and use the data in their projects. For example, the symbol_id object is essential for identifying which symbol the data pertains to, while the asks and bids objects allow developers to access the top levels of the order book and determine the current state of supply and demand for the symbol. Additionally, the price and size objects provide important information about the specific levels of the order book, which can be used to make informed trading decisions. Overall, the table is an essential resource for developers working with CoinAPI's crypto order book data.

JSON explained

This JSON output represents data from an order book for a cryptocurrency symbol traded on the BITSTAMP exchange. The symbol_id field identifies the specific symbol being traded, in this case BTC/USD. The time_exchange field contains the time at which the order book data was recorded by the exchange, while the time_coinapi field indicates the time at which CoinAPI received the data. The asks and bids fields contain lists of the top levels of the order book, with the asks field representing the lowest prices at which sellers are willing to sell the symbol and the bids field representing the highest prices at which buyers are willing to buy the symbol. Each element in the asks and bids lists contains a price field indicating the price of the level and a size field indicating the volume of the symbol being traded at that level. The order of the elements within the asks and bids lists is sorted from best to worst, with the best ask or bid at the top of the list.

[
{
"symbol_id": "BITSTAMP_SPOT_BTC_USD",
"time_exchange": "2013-09-28T22:40:50.0000000Z",
"time_coinapi": "2017-03-18T22:42:21.3763342Z",
"asks": [
{
"price": 456.35,
"size": 123
},
{
"price": 456.36,
"size": 23
},
... cut ...
],
"bids": [
{
"price": 456.10,
"size": 42
},
{
"price": 456.09,
"size": 5
},
... cut ...
]
}
]

Ending words

With this, we discussed the object table and JSON output specifically of CoinAPI's crypto order book API. We explained how the data is structured within these formats and provided examples to illustrate their use. We also discussed the usefulness of this information for developers looking to utilize CoinAPI's order book data in their projects. By understanding the different objects included in the data, developers can more easily access and use the data to make informed trading decisions.

Reference

To request access to CoinAPI's crypto order book API, you can visit the third party data marketplace of Worldindata. Worldindata is a platform that allows developers to purchase and access a wide range of APIs and data sets from various providers, including CoinAPI. To request access to CoinAPI's crypto order book API through Worldindata, you will need to create an account and follow the instructions provided on the platform. This may include agreeing to any applicable terms of service and providing payment information. Once you have completed the necessary steps, you will be able to access CoinAPI's crypto order book API through the Worldindata platform. Please note that access to CoinAPI's crypto order book API may be subject to fees and other conditions, and it is your responsibility to review and agree to these terms before requesting access.