Order Books
Update Order Book
Modify configuration or status of an existing order book
PATCH
Updates the configuration of an on-chain order book. Use this to pause or resume trading, adjust the fee structure, modify order size constraints, change the matching mode, or reconfigure the price reference layer.
Authentication
Requires an instance API key with thetrading service enabled.
Path Parameters
string
required
The order book identifier. Max 100 characters.
Request Body
All fields are optional. Only include fields you want to change.string
Order book status. One of
ACTIVE, PAUSED, or CLOSED. Setting to PAUSED stops new order submissions. CLOSED permanently deactivates the book.string
Updated minimum order size in base units (wei).
string | null
Updated maximum order size. Set to
null to remove the upper limit.string
Updated minimum price increment.
integer
Updated maker fee in basis points. 0-1000.
integer
Updated taker fee in basis points. 0-1000.
boolean
Whether other instances can import this order book.
Trading Mode (Hybrid Order Books)
string
Matching engine mode. One of
CONTINUOUS, PERIODIC_AUCTION, or HYBRID.integer
Auction clearing interval in seconds. Applies to
PERIODIC_AUCTION and HYBRID. 30-3600. Nullable.integer
Spread threshold in basis points that switches a
HYBRID book between continuous matching and auction batching. 1-10000. Nullable.boolean
Whether orders left unmatched at the end of an auction roll forward into the next auction.
integer
Maker rebate paid to registered market makers, in basis points. -1000 to 1000. Nullable.
Price Reference
boolean
Enable or disable price reference enforcement.
string
Source of the reference price. One of
MANUAL, STOCK_FEED, or EXTERNAL_FEED.string
Feed endpoint for
EXTERNAL_FEED. Max 2048 characters. Nullable.string
Serialized headers sent with the feed request. Max 4096 characters. Nullable.
string
Path used to extract the price from the feed response. Max 256 characters. Nullable.
string
Refresh and enforcement cadence. One of
EVERY_TRADE, 1MIN, 5MIN, 10MIN, 30MIN, 1HOUR, 6HOUR, 12HOUR, 1DAY.integer
Allowed band around the reference price, in basis points. 1-10000. Nullable.
boolean
Halt the order book when the reference price is stale.
integer
Maximum reference price age before it is considered stale, in seconds. 60-604800. Nullable.
integer
Circuit breaker threshold in basis points. 10-10000. Nullable.