Skip to main content
GET
Returns the auction a book is collecting into, or clearing right now. Applies to books running PERIODIC_AUCTION, and to HYBRID books while the spread failover holds them in batch mode. See Trading modes. data is null on a continuous book, and on a batching book between batches. That is the normal answer, not an error. An auction in COLLECTING has no clearingPrice: the price is computed when the batch closes, from the whole set of orders, and is not published in advance. orderCount and matchedVolume are likewise filled in at clearing.

Path Parameters

string
required
Order book ID.

Response Fields

object
null when no auction is live.
Orders routed into a batch rest with status AUCTION_PENDING and carry the auction’s ID. They do not appear in the continuous depth and cannot match until the batch clears.

Error Codes