Market Data - Starter Guide
Welcome to the CoinAPI developer documentation. This document should contain all the information required to properly implement applications using our API.
3 main interfaces can be used to access CoinAPI:
| API | Communication | Description |
|---|---|---|
| RESTful | Request-response | Stateless API provides the widest range of data, not capable of streaming, only pooling. |
| WebSocket | Publish-subscribe | Stateful API providing streaming of real-time market data. |
| FIX | Publish-subscribe | Stateful API providing streaming of real-time market data, widely adopted by the finance industry. |
SDK
Our Software Development Kit (SDK) is available on GitHub at https://github.com/coinapi/coinapi-sdk. If possible then we are strongly recommending using our tested libraries available on GitHub, rather than creating new ones. However, if you decide to create your implementation or to change the existing one, then we encourage you to create a Pull Request to our main repository with the proposed changes, we will able to include your code in our official repository for use by other users, effectively creating collaboration.
In the repository, you can find libraries or examples for languages or environments like:
- Python
- R
- Matlab
- C#
- C++
- .NET
- Java
- Ruby
- Go
- JavaScript
- TypeScript
- Node.js
- PHP
- Haskell
- Objective-C
- Swift
Security
The use of encryption is optional, and the decision to use it is on you. On the encrypted endpoints, we are using protocols that are considered the best security practices.
You should assume that we are always providing certificates signed by the Trusted Certification Authority.
Standards and conventions
This section represents used standards and conventions across all documents and API's.
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
Variables naming
All variables are named using the Snake case (or snake_case) naming convention.
This means that words are separated by a single underscore _ character, no spaces are used, and letters are lowercase.
Asset codes
ISO 4217 currency code standard is used for fiat money identifications. Cryptocurrency assets are identified using codes used by the general public or adopted by the majority of exchanges.
Exchange codes
Exchange on our platform is identified by the specific exchange API and the matching engine behind it. When the example exchange has multiple separate APIs, e.g., for different products SPOT, OPTIONS, or to cover other regions, we will expose these symbols from these respective APIs on different exchange identifiers. Below are examples of BINANCE (multiple APIs, multiple regions) and DERIBIT (single API, single region). A full listing of exchanges can be queried using the Market Data REST API.
| BINANCE Exchange IDs | Website | Description |
|---|---|---|
| BINANCE | https://www.binance.com/ | Binance |
| BINANCEDEX | https://www.binance.org/ | Binance DEX |
| BINANCEFTS | https://www.binance.com/ | Binance Futures (USDT/dapi) |
| BINANCEFTSC | https://www.binance.com/ | Binance Futures (Coin/fapi) |
| BINANCEFTSCUAT | https://www.binance.com/ | Binance Futures Testnet (Coin/fapi) |
| BINANCEFTSUAT | https://www.binance.com/ | Binance Futures Testnet (USDT/dapi) |
| BINANCEJE | https://www.binance.je/ | Binance Jersey |
| BINANCEJEX | https://www.jex.com/en | Binance JEX |
| BINANCEKR | https://www.binance.kr/ | Binance Korea |
| BINANCEOPTV | https://www.binance.com/ | Binance Options Vanilla (vapi) |
| BINANCEOPTVUAT | https://www.binance.com/ | Binance Options Vanilla Testnet (vapi) |
| BINANCEUAT | https://www.binance.com/ | Binance Testnet |
| BINANCEUG | https://www.binance.co.ug/ | Binance Uganda |
| BINANCEUS | https://www.binance.us/ | Binance US |
| DERIBIT Exchange IDs | Website | Description |
|---|---|---|
| DERIBIT | https://www.deribit.com/ | Deribit |
Numbers precision
Numbers in our platform can have a maximum of 19 digits overall, but no more than 9 decimal places. In cases when the number represents aggregate value then we allow 38 digits overall, but still no more than 9 decimal places.
Time
For all input and output time values ISO 8601 standard is used.
| Format specifier | Description |
|---|---|
yyyy | The year is a four-digit number. |
MM | The month, from 01 through 12. |
dd | The day of the month, from 01 through 31. |
HH | The hour, using a 24-hour clock from 00 to 23. |
mm | The minute, from 00 through 59. |
ss | The second, from 00 through 59. |
fff | The milliseconds in a date and time value. |
fffffff | The ten-millionths of a second in a date and time value. |
Input time values are parsed using the following formats as far as possible:
yyyy-MM-ddTHH:mm:ss.fffffffyyyy-MM-ddTHH:mm:ss.fffyyyy-MM-ddTHH:mm:ssyyyy-MM-ddTHH:mmyyyy-MM-ddTHHyyyy-MM-ddyyyyMMddTHHmmssfffffffyyyyMMddTHHmmssfffyyyyMMddTHHmmssyyyyMMddTHHmmyyyyMMddTHHyyyyMMdd
When time zone information is not supplied, we will assume the UTC zone.
Output time values are formatted using the following patterns:
yyyy-MM-ddTHH:mm:ss.fffffffZyyyy-MM-dd
All time values we provide are UTC zones. Do not assume otherwise.