Skip to main content
PATCH
Applies a partial update to a book your instance owns. Imported books are not updatable here; a request against another instance’s book returns ORDER_BOOK_NOT_FOUND. Only the fields you send are touched. The custody contract and settlement mode are not changeable on this surface.

Path Parameters

string
required
Order book ID.

Body Parameters

string
ACTIVE, PAUSED or CLOSED. Pausing stops new orders without touching resting ones. Reopening a CLOSED book is refused with ORDER_BOOK_EXISTS if another open book now quotes the same pair.
string
Smallest accepted quantity, in order book units.
string
Largest accepted quantity. Send null to remove the ceiling.
string
Price increment, in order book units.
integer
Maker fee in basis points, 0 to 1000.
integer
Taker fee in basis points, 0 to 1000.
boolean
Publish or unpublish the book for import.
boolean
Turn depth pooling on or off. Turning it on re-derives the fungibility class from the token’s current reserve attestation, and the request fails if no usable attestation exists. Turning it off leaves the recorded class in place but stops the book matching against it.
boolean
Turn the reference band on or off. Turning it off clears the cached reference price.
string
MANUAL, STOCK_FEED or EXTERNAL_FEED.
string
HTTPS feed endpoint, or null. Must resolve to a public host.
string
Feed headers as a JSON string, or null.
string
JSON path, or the ticker symbol in STOCK_FEED mode.
string
Refresh interval, from EVERY_TRADE to 1DAY.
integer
Band half-width in basis points, 1 to 10000, or null.
boolean
Whether a stale reference stops trading.
integer
Staleness window in seconds, 60 to 604800, or null.
integer
Reference move that pauses the book, 10 to 10000, or null.

Response Fields

Returns the updated book, in the same shape as Get Order Book.
Changing status or allowSharedLiquidity invalidates the peer cache immediately, so the change takes effect on the next order rather than after the 30-second window.

Error Codes