Skip to main content
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 the trading service enabled.

Path Parameters

orderBookId
string
required
The order book identifier. Max 100 characters.

Request Body

All fields are optional. Only include fields you want to change.
status
string
Order book status. One of ACTIVE, PAUSED, or CLOSED. Setting to PAUSED stops new order submissions. CLOSED permanently deactivates the book.
minOrderSize
string
Updated minimum order size in base units (wei).
maxOrderSize
string | null
Updated maximum order size. Set to null to remove the upper limit.
tickSize
string
Updated minimum price increment.
makerFeeBps
integer
Updated maker fee in basis points. 0-1000.
takerFeeBps
integer
Updated taker fee in basis points. 0-1000.
allowImport
boolean
Whether other instances can import this order book.

Trading Mode (Hybrid Order Books)

tradingMode
string
Matching engine mode. One of CONTINUOUS, PERIODIC_AUCTION, or HYBRID.
auctionIntervalSeconds
integer
Auction clearing interval in seconds. Applies to PERIODIC_AUCTION and HYBRID. 30-3600. Nullable.
hybridSwitchSpreadBps
integer
Spread threshold in basis points that switches a HYBRID book between continuous matching and auction batching. 1-10000. Nullable.
auctionRollUnmatched
boolean
Whether orders left unmatched at the end of an auction roll forward into the next auction.
mmMakerRebateBps
integer
Maker rebate paid to registered market makers, in basis points. -1000 to 1000. Nullable.

Price Reference

priceRefEnabled
boolean
Enable or disable price reference enforcement.
priceRefMode
string
Source of the reference price. One of MANUAL, STOCK_FEED, or EXTERNAL_FEED.
priceRefFeedUrl
string
Feed endpoint for EXTERNAL_FEED. Max 2048 characters. Nullable.
priceRefFeedHeaders
string
Serialized headers sent with the feed request. Max 4096 characters. Nullable.
priceRefFeedPath
string
Path used to extract the price from the feed response. Max 256 characters. Nullable.
priceRefEnforcement
string
Refresh and enforcement cadence. One of EVERY_TRADE, 1MIN, 5MIN, 10MIN, 30MIN, 1HOUR, 6HOUR, 12HOUR, 1DAY.
priceRefSpreadBps
integer
Allowed band around the reference price, in basis points. 1-10000. Nullable.
priceRefHaltOnStale
boolean
Halt the order book when the reference price is stale.
priceRefStaleTolerance
integer
Maximum reference price age before it is considered stale, in seconds. 60-604800. Nullable.
priceRefCircuitBreakerBps
integer
Circuit breaker threshold in basis points. 10-10000. Nullable.

Error Codes