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. Two properties of this venue are immutable: the custody contract and the token type. Neither the settlement mode nor the trading mode can be changed either, since external securities books are always on-chain and always continuous.

Idempotency

Accepts an optional Idempotency-Key header. A repeat with the same key and body replays the original response.

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
Rotate the wallet that signs settlements. The new wallet must already be authorized on the custody contract for this security. If it is not, the request is refused with 409 CUSTODY_SETUP_REQUIRED and the response carries the setOperator transaction for the security admin to sign.Access gates apply to the wallet that settles, so once the new wallet is authorized, its gates on chain must match the ones saved for the book. If they do not, the next request returns the accessGates step for the new wallet to sign.
object
Change who may trade on the book. Same shape as on Create Order Book. A side you leave out keeps its current gate, null removes it, and leaving out onboarding keeps the current onboarding settings.Onboarding settings alone are saved at once. A gate change is written on chain first: when the settlement operator’s gates differ from the requested ones, the request is refused with 409 CUSTODY_SETUP_REQUIRED and carries the setAccessGates transaction for the settlement operator to sign. Repeat the request with its hash under custodySetupTxs.accessGates, and the settings are saved once the chain shows the new gates. Removing the buyer gate of a security without an identity registry is refused with BUYER_GATE_REQUIRED.
string
AGENT or TRANSFER. Switches how the custody contract delivers this security, on every book that trades it. Only the security admin recorded at registration can sign the setDeliveryMode step. Switching to AGENT also returns the agentRole step when the custody contract does not hold the token’s delivery role yet. Requires the current custody contract. On generation 1 every book delivers as the token agent, so AGENT is accepted and changes nothing, and TRANSFER is refused with CUSTODY_UPGRADE_REQUIRED.
object
Change where the reference price comes from, in the shape described on Create Order Book. It sets priceRefMode, priceRefFeedUrl and priceRefFeedPath for you. For a CUSTOM source, leaving out headers keeps the stored headers under the same rules as priceRefFeedHeaders below. Changing the source clears the cached reference price.
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.
integer
Market maker fee override, −1000 to 1000, or null to remove it.
boolean
Publish or unpublish the book for import.
boolean
Turn depth pooling on or off. The peer cache is invalidated immediately, so the change takes effect on the next order rather than after the 30-second window.
object
Hashes of the transactions you signed after a CUSTODY_SETUP_REQUIRED refusal, keyed by the step key.
boolean
Turn the reference band on or off. Turning it off clears the cached reference price.
string
MANUAL, STOCK_FEED, COMMODITY_FEED or EXTERNAL_FEED. Prefer priceFeed, which sets this for you.
string
HTTPS feed endpoint, or null. Must resolve to a public host.
string
Feed headers as a JSON string. Headers are write-only, and a read returns "********" in their place. Sending "********" keeps the stored headers, so a read echoed back does not wipe them. null or an empty string clears them, and any other string replaces them. Stored headers are only sent to the host they were saved for: when priceRefFeedUrl moves to another host, "********" is refused with INVALID_CONFIG and the headers have to be sent again, and leaving priceRefFeedHeaders out clears them.
string
JSON path, the ticker symbol in STOCK_FEED mode, or the metal and unit in COMMODITY_FEED mode, such as XAU:GRAM.
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.
Rotating the settlement operator does not retire settlements already staged for the old one. A pending settlement’s calldata is rebuilt against the book’s current operator when you fetch it, so re-fetch with Get Settlement Calldata after a rotation rather than broadcasting a payload built earlier.

Error Codes