Skip to main content
GET
Returns the book’s reference configuration together with the live price and the band derived from it. The price is resolved the same way an incoming order would resolve it: from cache if the enforcement interval has not elapsed, otherwise from the configured source. A book with the reference disabled returns its configuration with currentPrice, lowerBound and upperBound all null. So does a book whose source could not be reached. The read is deliberately forgiving here, and a fetch failure is reported as an absent price rather than an error, because a monitoring call should not fail just because a feed blinked. Submit Order takes the stricter view and can refuse with PRICE_REF_STALE.

Path Parameters

string
required
Order book ID.

Response Fields

object
Bounds are decimals in the instrument’s currency. An order’s price is an order book unit integer, so divide it by 1000000 before comparing it against lowerBound and upperBound.

Error Codes