API Documentation | Intrinio

API Documentation

Crypto Book Summary

Crypto Book Summary

Returns the order book summary (bid/ask prices and size) for a given currency pair and exchange.

Endpoint:
https://api.intrinio.com/crypto/book
Available in Sandbox

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. 25
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. gemini
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
pair
Data for the provided crypto currency pair. object
name
Crypto currency pair name. string
code
Crypto currency pair code. string
exchange
Data for the provided crypto exchange. object
name
Crypto exchange name. string
code
Crypto exchange code. string
last_updated UTC timestamp of when the order book was last updated. string
bids
The bid prices and their respective sizes, in descending order of price. array
price
The bid price of the book entry. float
size
The size for the bid price of the book entry. float
asks
The ask prices and their respective sizes, in ascending order of price. array
price
The ask price of the book entry. float
size
The size for the ask price of the book entry. float
pair
Data for the provided crypto currency pair.
exchange
Data for the provided crypto exchange.
last_updated
UTC timestamp of when the order book was last updated.
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.