Off-Chain Settlement
Create Off-Chain Order Book
Open a book that settles on your custody ledger instead of on chain
POST
Creates a book that settles against your instance’s custody ledger. There is no custody contract and no on-chain prerequisite, so the book is usable immediately.
Off-chain is the settlement mode stock orders execute in. See Settlement modes.
Three properties are fixed by this route and cannot be overridden: the settlement mode is
OFF_CHAIN, no custody contract is attached, and the book is never publishable for import. Everything else behaves as it does on an on-chain book.
Authentication
Authenticates with an instance API key like the rest of the surface, but does not require the Trading service entitlement, because nothing here touches a custody contract.Body Parameters
string
required
Base token contract. Must be registered in your instance’s custody ledger before orders can be placed against it.
string
required
Settlement token (stablecoin) contract, also registered in the ledger. Must differ from
tokenAddress.string
required
Display name, 1 to 64 characters.
string
required
Display symbol, 1 to 16 characters.
string
default:"LIGHT_TOKEN"
STOCK_TOKEN or LIGHT_TOKEN. Set STOCK_TOKEN if the book should also appear in the stock reads, which filter on that type.string
Your stock token record ID, up to 100 characters.
string
default:"0"
Smallest accepted quantity, in order book units.
string
Largest accepted quantity, in order book units.
string
default:"1"
Price increment, in order book units.
integer
default:"0"
Maker fee in basis points, 0 to 1000.
integer
default:"0"
Taker fee in basis points, 0 to 1000.
boolean
default:"false"
Enforce a reference price band.
string
default:"MANUAL"
MANUAL or EXTERNAL_FEED. The market data feed mode is not offered on this route.string
HTTPS feed endpoint, up to 2048 characters. Must resolve to a public host.
string
Feed request headers as a JSON string, up to 4096 characters.
string
Dot-separated JSON path to the price in the feed response.
string
default:"EVERY_TRADE"
Refresh interval, from
EVERY_TRADE to 1DAY.integer
Band half-width in basis points, 1 to 10000.
boolean
default:"false"
Refuse orders when the reference is stale.
integer
Staleness window in seconds, 60 to 604800.
Response Fields
Returns201 with the created book, in the same shape as Get Order Book. settlementMode is OFF_CHAIN, custodyContract is null, and allowImport is false.
A circuit breaker cannot be configured on this route. To attach one, create the book here and then set
priceRefCircuitBreakerBps with Update Order Book.