Skip to main content
POST
Records a reference price on a book and makes it effective immediately. Use this in MANUAL mode; in the feed modes the reference is fetched, and a value posted here is overwritten by the next fetch. For a security with no continuous market price, a periodically published net asset value is the natural reference. Enforcement of 1HOUR or 1DAY with a wide priceRefSpreadBps fits that pattern better than tick-by-tick enforcement. 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 "104.20". The instrument’s price in the settlement currency, not an order book unit value. Up to 64 characters.

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. Band sweep. If the circuit breaker did not trip and priceRefSpreadBps is set, resting 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.
Cancelling an order for a band violation removes it from this venue and frees the reservation. It does not invalidate the trader’s signature on chain. If the price moved because something changed about the instrument, tell traders to retire their signatures with Cancel Orders On Chain.

Response Fields

object

Error Codes