API Documentation

We have released a new API version! Select v1 to see the old version.

Crypto Book Summary

Crypto Book Summary

Returns the order book summary (bid/ask prices and size) for a given Crypto Currency Pair and Crypto Exchange.

Endpoint:
https://api-v2.intrinio.com/crypto/book

Parameters

Name Description Example
levels
The number of prices/levels to return on each side. For example, the max of 50 levels will return up to 50 bid prices and 50 ask prices. 50
pair
Return the order book summary for the given Crypto Currency Pair. btcusd
exchange
Return the order book summary for a Crypto Currency on the given Crypto Exchange. binance
currency
Return the order book summary for the given Crypto Currency. BTC
levels
* required
The number of prices/levels to return on each side. For example, the max of 50 levels will return up to 50 bid prices and 50 ask prices.
pair
* required
Return the order book summary for the given Crypto Currency Pair.
exchange
* required
Return the order book summary for a Crypto Currency on the given Crypto Exchange.
currency
* required
Return the order book summary for the given Crypto Currency.

Output Fields

Name Description Type Example
bids
The bid prices and their respective sizes, in descending order of price. array -
price
The price of the book entry. number 6492.88
size
The size for the price of the book entry. number 1.0
asks
The ask prices and their respective sizes, in ascending order of price. array -
price
The price of the book entry. number 6492.88
size
The size for the price of the book entry. number 1.0
pair
object -
name
The Crypto Currency Pair name. string Bitcoin
code
The Crypto Currency Pair code. string bitcoin
exchange
object -
name
The Crypto Exchange name. string Binance
code
The Crypto Exchange code. string binance
last_updated The UTC timestamp of when the order book was last updated. string 2018-07-19 21:00:00 UTC
bids
The bid prices and their respective sizes, in descending order of price.
asks
The ask prices and their respective sizes, in ascending order of price.
pair
exchange
last_updated
The UTC timestamp of when the order book was last updated.