By default, only the inside (i.e. best) bid and ask are returned. This is equivalent to a book depth of 1 level. If you would like to see a larger order book, specify the
level query parameter.
If a level is not aggregated, then all of the orders at each price will be returned. Aggregated levels return only one size for each active price (as if there was only a single order for that size at the level).
|1||The best bid, ask and auction info|
|2||Full order book (aggregated) and auction info|
|3||Full order book (non aggregated) and auction info|
Levels 1 and 2 are aggregated. The
size field is the sum of the size of the orders at that
num-orders is the count of orders at that
size should not be multiplied by
Level 3 is non-aggregated and returns the entire order book.
While the book is in an auction, the L1, L2 and L3 book will also contain the most recent indicative quote disseminated during the auction, and
auction_mode will be set to true.
These indicative quote messages are sent on an interval basis (approximately once a second) during the collection phase of an auction and includes information about the tentative price and size affiliated with the completion.
Opening Price - The price used for matching all the orders as the auction enters the opening state
Opening Size - Aggregate size of all the orders eligible for crossing
Best Bid/Ask Price and Size - The anticipated BBO upon entering trading after matching has completed
Since these indicative quote messages get disseminated on an interval basis, the values aren’t firm as changes in the book may occur between the last update and beginning the transition from auction mode to trading.
While in auction mode, the auction_state indicates what phase the auction is in which includes:
collection state indicates the auction is currently accepting orders and cancellations within the book. During this state, orders will not match and the book may appear crossed in the market data feeds.
opening state indicates the book transitions towards full trading or limit only. During
opening state any buy orders at or over the open price and any sell orders at or below the open price may cross during the opening phase. Matches in this stage are charged taker fees. Any new orders or cancels entered while in the opening phase get queued and processed when the market resumes trading.
complete state indicates the dissemination of opening trades is finishing, and immediately after that the book goes into the next mode (either full trading or limit only).
opening state will likely pass by too fast in most normal scenarios to see these states show up in the REST API.
collection state the
can_open field indicates whether or not the book can complete the auction and enter full trading or limit only mode.
can_open: yes indicates the book is in a healthy state and the book can enter full trading or limit only once the auction collection state finishes.
can_open: no indicates the book cannot continue to full trading or limit only.
Once a book leaves auction mode — either by moving to full trading, or canceled by our market ops team — the book endpoint will no longer show indicative quote data and display
auction_mode as false.
This request is NOT paginated. The entire book is returned in one response.
Level 1 and Level 2 are recommended for polling. For the most up-to-date data, consider using the websocket stream. Level 3 is only recommended for users wishing to maintain a full real-time order book using the websocket stream. Abuse of Level 3 via polling will cause your access to be limited or blocked.