Skip to main content
POST
Records a reference price on a book and makes it effective immediately. Use this when the book is in MANUAL mode; in STOCK_FEED or EXTERNAL_FEED mode the reference is fetched rather than pushed, and a value posted here is overwritten by the next fetch. The book must belong to your instance and must have priceRefEnabled set, otherwise the request is refused with PRICE_REF_DISABLED. Publishing a price has three effects beyond storing it. It resets the staleness clock. It writes an entry into the price reference log. And if the move is large enough it can pause the book or cancel resting orders.

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 "182.35". This is the instrument’s price in the quote currency, not an order book unit value. Up to 64 characters, digits with at most one decimal point.

Side effects

Circuit breaker. If priceRefCircuitBreakerBps 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 that now fall outside the band are cancelled with PRICE_BAND_VIOLATION and their reservations released. This runs in the background, so the cancellations may land a moment after the response. Neither runs on the first price a book ever receives, since there is nothing to compare against.

Response Fields

object

Error Codes