Order Books
Get Order Book
Retrieve the full configuration of one stock order book
GET
/
orderbooks
/
stocks
/
api
/
order-books
/
{orderBookId}
curl "https://api.trusset.org/orderbooks/stocks/api/order-books/clx_ob_stock_001" \
-H "X-API-Key: trusset_your_key_here"
const res = await fetch(
`https://api.trusset.org/orderbooks/stocks/api/order-books/${orderBookId}`,
{ headers: { 'X-API-Key': 'trusset_your_key_here' } }
);
const { data } = await res.json();
console.log(data.symbol, data.settlementMode, data.status);
{
"success": true,
"data": {
"id": "clx_ob_stock_001",
"instanceId": "inst_abc123",
"tokenAddress": "0xabc7f1093d5e26b804a1c3f78de025916b47c0d3",
"quoteTokenAddress": "0x98ad0ca091552e23c564b41c74282e5343d03e8a",
"name": "Nyala Fund I",
"symbol": "NYF1",
"status": "ACTIVE",
"tokenType": "STOCK_TOKEN",
"settlementMode": "OFF_CHAIN",
"custodyContract": null,
"underlyingIdentifier": null,
"stockTokenId": "stk_014",
"minOrderSize": "1000000",
"maxOrderSize": null,
"tickSize": "10000",
"makerFeeBps": 5,
"takerFeeBps": 15,
"mmMakerRebateBps": null,
"allowImport": false,
"allowSharedLiquidity": false,
"tradingMode": "CONTINUOUS",
"auctionIntervalSeconds": null,
"currentAuctionId": null,
"hybridSwitchSpreadBps": null,
"auctionRollUnmatched": true,
"cfid": null,
"baseDecimals": null,
"quoteDecimals": null,
"settlementOperator": null,
"priceRefEnabled": true,
"priceRefMode": "STOCK_FEED",
"priceRefFeedUrl": null,
"priceRefFeedHeaders": null,
"priceRefFeedPath": "NYF1",
"priceRefEnforcement": "5MIN",
"priceRefSpreadBps": 200,
"priceRefLastPrice": "182.35",
"priceRefLastUpdated": "2025-06-15T11:58:00.000Z",
"priceRefHaltOnStale": true,
"priceRefStaleTolerance": null,
"priceRefCircuitBreakerBps": 1500,
"createdAt": "2025-06-01T09:00:00.000Z",
"updatedAt": "2025-06-15T11:58:00.000Z"
}
}
{
"success": false,
"data": null,
"error": {
"code": "ORDER_BOOK_NOT_FOUND",
"message": "Order book not found"
}
}
Returns the stored record for a single book: its pair, status, sizing rules, fees, trading mode, and price reference configuration.
Books you own and books you have imported both resolve here. A book that is neither, or one whose token type is not
STOCK_TOKEN, returns ORDER_BOOK_NOT_FOUND rather than disclosing that it exists.
Path Parameters
string
required
Order book ID.
Response Fields
object
Show child attributes
Show child attributes
string
Order book ID.
string
Owning instance. Differs from yours on an imported book.
string
Base token.
string
Quote token.
string
Display name.
string
Display symbol.
string
ACTIVE, PAUSED or CLOSED.string
STOCK_TOKEN.string
OFF_CHAIN or ON_CHAIN.string
Custody contract, or
null off-chain.string
ISIN recorded from the token, or
null.string
Linked stock token record, or
null.string
Minimum quantity in order book units.
string
Maximum quantity, or
null.string
Price increment in order book units.
integer
Maker fee in basis points.
integer
Taker fee in basis points.
integer
Fee applied in place of
makerFeeBps for market maker accounts, or null.boolean
Whether other instances may import the book.
boolean
Whether the book pools depth with its peers.
string
CONTINUOUS, PERIODIC_AUCTION or HYBRID.integer
Auction batch length, or
null.string
Auction currently collecting, or
null. On a HYBRID book a non-null value means the failover is active.integer
Spread that triggers hybrid failover, or
null.boolean
Whether unmatched auction orders roll forward.
string
Commodity fungibility class.
null on stock books.integer
Recorded for external securities books only.
null here.integer
Recorded for external securities books only.
null here.string
Recorded for external securities books only.
null here.boolean
Whether the band is enforced.
string
MANUAL, STOCK_FEED or EXTERNAL_FEED.string
External feed endpoint, or
null.string
Feed headers as a JSON string, or
null.string
JSON path, or the ticker in
STOCK_FEED mode.string
Refresh interval.
integer
Band half-width in basis points, or
null.string
Last recorded reference price, as a plain decimal.
string
ISO 8601 timestamp, or
null.boolean
Whether a stale reference stops trading.
integer
Staleness window in seconds, or
null for the derived default.integer
Move that pauses the book, or
null.string
ISO 8601 timestamp.
string
ISO 8601 timestamp.
curl "https://api.trusset.org/orderbooks/stocks/api/order-books/clx_ob_stock_001" \
-H "X-API-Key: trusset_your_key_here"
const res = await fetch(
`https://api.trusset.org/orderbooks/stocks/api/order-books/${orderBookId}`,
{ headers: { 'X-API-Key': 'trusset_your_key_here' } }
);
const { data } = await res.json();
console.log(data.symbol, data.settlementMode, data.status);
{
"success": true,
"data": {
"id": "clx_ob_stock_001",
"instanceId": "inst_abc123",
"tokenAddress": "0xabc7f1093d5e26b804a1c3f78de025916b47c0d3",
"quoteTokenAddress": "0x98ad0ca091552e23c564b41c74282e5343d03e8a",
"name": "Nyala Fund I",
"symbol": "NYF1",
"status": "ACTIVE",
"tokenType": "STOCK_TOKEN",
"settlementMode": "OFF_CHAIN",
"custodyContract": null,
"underlyingIdentifier": null,
"stockTokenId": "stk_014",
"minOrderSize": "1000000",
"maxOrderSize": null,
"tickSize": "10000",
"makerFeeBps": 5,
"takerFeeBps": 15,
"mmMakerRebateBps": null,
"allowImport": false,
"allowSharedLiquidity": false,
"tradingMode": "CONTINUOUS",
"auctionIntervalSeconds": null,
"currentAuctionId": null,
"hybridSwitchSpreadBps": null,
"auctionRollUnmatched": true,
"cfid": null,
"baseDecimals": null,
"quoteDecimals": null,
"settlementOperator": null,
"priceRefEnabled": true,
"priceRefMode": "STOCK_FEED",
"priceRefFeedUrl": null,
"priceRefFeedHeaders": null,
"priceRefFeedPath": "NYF1",
"priceRefEnforcement": "5MIN",
"priceRefSpreadBps": 200,
"priceRefLastPrice": "182.35",
"priceRefLastUpdated": "2025-06-15T11:58:00.000Z",
"priceRefHaltOnStale": true,
"priceRefStaleTolerance": null,
"priceRefCircuitBreakerBps": 1500,
"createdAt": "2025-06-01T09:00:00.000Z",
"updatedAt": "2025-06-15T11:58:00.000Z"
}
}
{
"success": false,
"data": null,
"error": {
"code": "ORDER_BOOK_NOT_FOUND",
"message": "Order book not found"
}
}
Error Codes
| Code | HTTP | Cause |
|---|---|---|
ORDER_BOOK_NOT_FOUND | 404 | No such book on this instance, not imported, or not a stock book |
SERVICE_NOT_ENABLED | 403 | The Trading service is not enabled on this instance |
⌘I
curl "https://api.trusset.org/orderbooks/stocks/api/order-books/clx_ob_stock_001" \
-H "X-API-Key: trusset_your_key_here"
const res = await fetch(
`https://api.trusset.org/orderbooks/stocks/api/order-books/${orderBookId}`,
{ headers: { 'X-API-Key': 'trusset_your_key_here' } }
);
const { data } = await res.json();
console.log(data.symbol, data.settlementMode, data.status);
{
"success": true,
"data": {
"id": "clx_ob_stock_001",
"instanceId": "inst_abc123",
"tokenAddress": "0xabc7f1093d5e26b804a1c3f78de025916b47c0d3",
"quoteTokenAddress": "0x98ad0ca091552e23c564b41c74282e5343d03e8a",
"name": "Nyala Fund I",
"symbol": "NYF1",
"status": "ACTIVE",
"tokenType": "STOCK_TOKEN",
"settlementMode": "OFF_CHAIN",
"custodyContract": null,
"underlyingIdentifier": null,
"stockTokenId": "stk_014",
"minOrderSize": "1000000",
"maxOrderSize": null,
"tickSize": "10000",
"makerFeeBps": 5,
"takerFeeBps": 15,
"mmMakerRebateBps": null,
"allowImport": false,
"allowSharedLiquidity": false,
"tradingMode": "CONTINUOUS",
"auctionIntervalSeconds": null,
"currentAuctionId": null,
"hybridSwitchSpreadBps": null,
"auctionRollUnmatched": true,
"cfid": null,
"baseDecimals": null,
"quoteDecimals": null,
"settlementOperator": null,
"priceRefEnabled": true,
"priceRefMode": "STOCK_FEED",
"priceRefFeedUrl": null,
"priceRefFeedHeaders": null,
"priceRefFeedPath": "NYF1",
"priceRefEnforcement": "5MIN",
"priceRefSpreadBps": 200,
"priceRefLastPrice": "182.35",
"priceRefLastUpdated": "2025-06-15T11:58:00.000Z",
"priceRefHaltOnStale": true,
"priceRefStaleTolerance": null,
"priceRefCircuitBreakerBps": 1500,
"createdAt": "2025-06-01T09:00:00.000Z",
"updatedAt": "2025-06-15T11:58:00.000Z"
}
}
{
"success": false,
"data": null,
"error": {
"code": "ORDER_BOOK_NOT_FOUND",
"message": "Order book not found"
}
}