Order Books
Get Order Book
Retrieve the full configuration of one external securities book
GET
/
orderbooks
/
external-securities
/
api
/
order-books
/
{orderBookId}
curl "https://api.trusset.org/orderbooks/external-securities/api/order-books/clx_ob_extsec_001" \
-H "X-API-Key: trusset_your_key_here"
const res = await fetch(
`https://api.trusset.org/orderbooks/external-securities/api/order-books/${orderBookId}`,
{ headers: { 'X-API-Key': 'trusset_your_key_here' } }
);
const { data } = await res.json();
console.log(data.symbol, data.underlyingIdentifier, data.baseDecimals, data.quoteDecimals);
{
"success": true,
"data": {
"id": "clx_ob_extsec_001",
"instanceId": "inst_abc123",
"tokenAddress": "0x51f2b9d0e77c4a1b83ce6d4a9271e5f3a0c8b912",
"quoteTokenAddress": "0x98ad0ca091552e23c564b41c74282e5343d03e8a",
"name": "Helvetia Growth Fund",
"symbol": "HELG",
"status": "ACTIVE",
"tokenType": "EXTERNAL_SECURITY",
"settlementMode": "ON_CHAIN",
"custodyContract": "0x489aee4ae9546081d55848f157e03192e826988c",
"settlementOperator": "0x5ad87a0621175206b72d10e4b8577b192e7f40ab",
"underlyingIdentifier": "CH0012032048",
"baseDecimals": 18,
"quoteDecimals": 6,
"minOrderSize": "1000000",
"maxOrderSize": null,
"tickSize": "10000",
"makerFeeBps": 0,
"takerFeeBps": 10,
"mmMakerRebateBps": null,
"allowImport": true,
"allowSharedLiquidity": true,
"tradingMode": "CONTINUOUS",
"cfid": null,
"stockTokenId": null,
"priceRefEnabled": true,
"priceRefMode": "MANUAL",
"priceRefFeedUrl": null,
"priceRefFeedHeaders": null,
"priceRefFeedPath": null,
"priceRefEnforcement": "1HOUR",
"priceRefSpreadBps": 500,
"priceRefLastPrice": "104.20",
"priceRefLastUpdated": "2025-06-15T11:00:00.000Z",
"priceRefHaltOnStale": false,
"priceRefStaleTolerance": null,
"priceRefCircuitBreakerBps": 2000,
"createdAt": "2025-06-01T09:00:00.000Z",
"updatedAt": "2025-06-15T11:00:00.000Z"
}
}
Returns the stored record for a single book: its pair, status, recorded decimals, settlement operator, sizing rules, fees, and price reference configuration.
Books you own and books you have imported both resolve. A book that is neither, or whose token type is not an external security, returns
ORDER_BOOK_NOT_FOUND rather than disclosing that it exists.
This read is stored state only. For live on-chain registration, authorization and balances, use Get Security Status.
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
Security token.
string
Settlement asset.
string
Display name.
string
Display symbol.
string
ACTIVE, PAUSED or CLOSED.string
EXTERNAL_SECURITY.string
ON_CHAIN.string
Custody contract the book settles through.
string
Wallet authorized to sign settlements for this book.
string
Instrument identifier recorded on chain. Shared liquidity keys on this.
integer
Security token decimals, read at creation.
integer
Settlement asset decimals, read at creation.
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
Market maker fee override, or
null.boolean
Whether other instances may import the book.
boolean
Whether the book pools depth with its peers.
string
CONTINUOUS.string
Commodity fungibility class.
null on this venue.string
null on this venue.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.integer
Move that pauses the book, or
null.string
ISO 8601 timestamp.
string
ISO 8601 timestamp.
curl "https://api.trusset.org/orderbooks/external-securities/api/order-books/clx_ob_extsec_001" \
-H "X-API-Key: trusset_your_key_here"
const res = await fetch(
`https://api.trusset.org/orderbooks/external-securities/api/order-books/${orderBookId}`,
{ headers: { 'X-API-Key': 'trusset_your_key_here' } }
);
const { data } = await res.json();
console.log(data.symbol, data.underlyingIdentifier, data.baseDecimals, data.quoteDecimals);
{
"success": true,
"data": {
"id": "clx_ob_extsec_001",
"instanceId": "inst_abc123",
"tokenAddress": "0x51f2b9d0e77c4a1b83ce6d4a9271e5f3a0c8b912",
"quoteTokenAddress": "0x98ad0ca091552e23c564b41c74282e5343d03e8a",
"name": "Helvetia Growth Fund",
"symbol": "HELG",
"status": "ACTIVE",
"tokenType": "EXTERNAL_SECURITY",
"settlementMode": "ON_CHAIN",
"custodyContract": "0x489aee4ae9546081d55848f157e03192e826988c",
"settlementOperator": "0x5ad87a0621175206b72d10e4b8577b192e7f40ab",
"underlyingIdentifier": "CH0012032048",
"baseDecimals": 18,
"quoteDecimals": 6,
"minOrderSize": "1000000",
"maxOrderSize": null,
"tickSize": "10000",
"makerFeeBps": 0,
"takerFeeBps": 10,
"mmMakerRebateBps": null,
"allowImport": true,
"allowSharedLiquidity": true,
"tradingMode": "CONTINUOUS",
"cfid": null,
"stockTokenId": null,
"priceRefEnabled": true,
"priceRefMode": "MANUAL",
"priceRefFeedUrl": null,
"priceRefFeedHeaders": null,
"priceRefFeedPath": null,
"priceRefEnforcement": "1HOUR",
"priceRefSpreadBps": 500,
"priceRefLastPrice": "104.20",
"priceRefLastUpdated": "2025-06-15T11:00:00.000Z",
"priceRefHaltOnStale": false,
"priceRefStaleTolerance": null,
"priceRefCircuitBreakerBps": 2000,
"createdAt": "2025-06-01T09:00:00.000Z",
"updatedAt": "2025-06-15T11:00:00.000Z"
}
}
Error Codes
| Code | HTTP | Cause |
|---|---|---|
ORDER_BOOK_NOT_FOUND | 404 | No such external securities book on this instance, and not imported |
SERVICE_NOT_ENABLED | 403 | The Trading service is not enabled on this instance |
⌘I
curl "https://api.trusset.org/orderbooks/external-securities/api/order-books/clx_ob_extsec_001" \
-H "X-API-Key: trusset_your_key_here"
const res = await fetch(
`https://api.trusset.org/orderbooks/external-securities/api/order-books/${orderBookId}`,
{ headers: { 'X-API-Key': 'trusset_your_key_here' } }
);
const { data } = await res.json();
console.log(data.symbol, data.underlyingIdentifier, data.baseDecimals, data.quoteDecimals);
{
"success": true,
"data": {
"id": "clx_ob_extsec_001",
"instanceId": "inst_abc123",
"tokenAddress": "0x51f2b9d0e77c4a1b83ce6d4a9271e5f3a0c8b912",
"quoteTokenAddress": "0x98ad0ca091552e23c564b41c74282e5343d03e8a",
"name": "Helvetia Growth Fund",
"symbol": "HELG",
"status": "ACTIVE",
"tokenType": "EXTERNAL_SECURITY",
"settlementMode": "ON_CHAIN",
"custodyContract": "0x489aee4ae9546081d55848f157e03192e826988c",
"settlementOperator": "0x5ad87a0621175206b72d10e4b8577b192e7f40ab",
"underlyingIdentifier": "CH0012032048",
"baseDecimals": 18,
"quoteDecimals": 6,
"minOrderSize": "1000000",
"maxOrderSize": null,
"tickSize": "10000",
"makerFeeBps": 0,
"takerFeeBps": 10,
"mmMakerRebateBps": null,
"allowImport": true,
"allowSharedLiquidity": true,
"tradingMode": "CONTINUOUS",
"cfid": null,
"stockTokenId": null,
"priceRefEnabled": true,
"priceRefMode": "MANUAL",
"priceRefFeedUrl": null,
"priceRefFeedHeaders": null,
"priceRefFeedPath": null,
"priceRefEnforcement": "1HOUR",
"priceRefSpreadBps": 500,
"priceRefLastPrice": "104.20",
"priceRefLastUpdated": "2025-06-15T11:00:00.000Z",
"priceRefHaltOnStale": false,
"priceRefStaleTolerance": null,
"priceRefCircuitBreakerBps": 2000,
"createdAt": "2025-06-01T09:00:00.000Z",
"updatedAt": "2025-06-15T11:00:00.000Z"
}
}