Skip to main content
GET
Returns a single auction on a book, live or historical. Once the batch has cleared, this is where the uniform clearing price and the matched volume are published. data is null when no auction with that ID exists on that book. The endpoint does not distinguish a wrong ID from an auction that belongs to a different book.

How the clearing price is chosen

At the end of a batch the engine considers every distinct price present in the collected orders and computes how much volume would trade at each. It picks the price that maximizes matched volume; ties are broken by the smaller order imbalance, then by proximity to the book’s reference price. Fills are then allocated at that single price by strict price then time priority, so an order that arrived earlier at the same price is filled first. Orders the batch could not fill either roll into the next batch or are cancelled, according to the book’s auctionRollUnmatched setting.

Path Parameters

string
required
Order book ID.
string
required
Auction ID, from Get Current Auction or an order’s auctionId.

Response Fields

object
null when the auction does not exist on that book.

Error Codes