Price Reference
Set Price Reference
Publish a manual reference price for a commodity book
POST
Records a reference price on a book and makes it effective immediately. Use this when the book is in
MANUAL mode; in the feed modes the reference is fetched, and a value posted here is overwritten by the next fetch.
Commodities usually have a live external benchmark, so a feed is the natural configuration and manual pricing is the fallback when the feed is down or the instrument has no public quote.
The book must belong to your instance and have priceRefEnabled set, otherwise the request is refused with PRICE_REF_DISABLED.
Path Parameters
string
required
Order book ID. Must be a book your instance owns.
Body Parameters
string
required
Reference price as a plain positive decimal, such as
"2412.55". The commodity’s price in the quote currency per unit of the token, not an order book unit value. Up to 64 characters.Side effects
Circuit breaker. IfpriceRefCircuitBreakerBps is set and the new price differs from the previous one by more than that threshold, the book is moved to PAUSED and a CIRCUIT_BREAKER_TRIGGERED entry is written to the log. The request still succeeds; the pause is the response to it. Reopen the book with Update Order Book once you are satisfied the move is real.
Band sweep. If the circuit breaker did not trip and priceRefSpreadBps is set, resting limit orders now outside the band are cancelled with PRICE_BAND_VIOLATION and their reservations released. This runs in the background, so cancellations may land a moment after the response.
Neither runs on the first price a book ever receives.
Response Fields
object
