Price Reference
Get Price Reference
Read the current reference price and the band it implies
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. This read is forgiving, so a monitoring call does not fail 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
The stale-handling settings are not echoed here. Read
priceRefHaltOnStale and priceRefStaleTolerance from Get Order Book if you need them.Bounds are decimals in the settlement currency. An order’s price is an order book unit integer, so divide it by 1000000 before comparing.