Order Books
Get Order Book
Retrieve details of a specific order book
GET
/
orderbooks
/
stocks
/
api
/
order-books
/
{orderBookId}
curl -X GET "https://api.trusset.org/orderbooks/stocks/api/order-books/ob_abc123" \
-H "x-api-key: trusset_{instanceRef}_{secret}"
{
"success": true,
"data": {
"id": "ob_abc123",
"tokenAddress": "0x1234567890abcdef1234567890abcdef12345678",
"quoteTokenAddress": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd",
"name": "ACME Corp Shares / EURC",
"symbol": "ACME/EURC",
"status": "ACTIVE",
"settlementMode": "ON_CHAIN",
"custodyContract": "0x9876543210fedcba9876543210fedcba98765432",
"minOrderSize": "1000000000000000000",
"maxOrderSize": null,
"tickSize": "100000000000000",
"makerFeeBps": 10,
"takerFeeBps": 25,
"tokenType": "STOCK_TOKEN",
"stockTokenId": "acme-corp-001",
"underlyingIdentifier": "US0000ACME01",
"allowImport": true,
"tradingMode": "HYBRID",
"auctionIntervalSeconds": 300,
"hybridSwitchSpreadBps": 50,
"auctionRollUnmatched": true,
"mmMakerRebateBps": 5,
"priceRefEnabled": true,
"priceRefMode": "EXTERNAL_FEED",
"priceRefEnforcement": "1MIN",
"priceRefSpreadBps": 200,
"priceRefHaltOnStale": true,
"priceRefStaleTolerance": 300,
"priceRefCircuitBreakerBps": 1000
},
"metadata": {
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2025-01-15T10:30:00.000Z",
"instanceId": "inst_abc"
}
}
Returns the full configuration and current status of a single on-chain order book, including its matching mode and price reference settings.
Authentication
Requires an instance API key with thetrading service enabled.
Path Parameters
string
required
The order book identifier.
curl -X GET "https://api.trusset.org/orderbooks/stocks/api/order-books/ob_abc123" \
-H "x-api-key: trusset_{instanceRef}_{secret}"
{
"success": true,
"data": {
"id": "ob_abc123",
"tokenAddress": "0x1234567890abcdef1234567890abcdef12345678",
"quoteTokenAddress": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd",
"name": "ACME Corp Shares / EURC",
"symbol": "ACME/EURC",
"status": "ACTIVE",
"settlementMode": "ON_CHAIN",
"custodyContract": "0x9876543210fedcba9876543210fedcba98765432",
"minOrderSize": "1000000000000000000",
"maxOrderSize": null,
"tickSize": "100000000000000",
"makerFeeBps": 10,
"takerFeeBps": 25,
"tokenType": "STOCK_TOKEN",
"stockTokenId": "acme-corp-001",
"underlyingIdentifier": "US0000ACME01",
"allowImport": true,
"tradingMode": "HYBRID",
"auctionIntervalSeconds": 300,
"hybridSwitchSpreadBps": 50,
"auctionRollUnmatched": true,
"mmMakerRebateBps": 5,
"priceRefEnabled": true,
"priceRefMode": "EXTERNAL_FEED",
"priceRefEnforcement": "1MIN",
"priceRefSpreadBps": 200,
"priceRefHaltOnStale": true,
"priceRefStaleTolerance": 300,
"priceRefCircuitBreakerBps": 1000
},
"metadata": {
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2025-01-15T10:30:00.000Z",
"instanceId": "inst_abc"
}
}
Error Codes
| Code | Status | Description |
|---|---|---|
ORDER_BOOK_NOT_FOUND | 404 | No order book found with this ID in your instance |
⌘I
curl -X GET "https://api.trusset.org/orderbooks/stocks/api/order-books/ob_abc123" \
-H "x-api-key: trusset_{instanceRef}_{secret}"
{
"success": true,
"data": {
"id": "ob_abc123",
"tokenAddress": "0x1234567890abcdef1234567890abcdef12345678",
"quoteTokenAddress": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd",
"name": "ACME Corp Shares / EURC",
"symbol": "ACME/EURC",
"status": "ACTIVE",
"settlementMode": "ON_CHAIN",
"custodyContract": "0x9876543210fedcba9876543210fedcba98765432",
"minOrderSize": "1000000000000000000",
"maxOrderSize": null,
"tickSize": "100000000000000",
"makerFeeBps": 10,
"takerFeeBps": 25,
"tokenType": "STOCK_TOKEN",
"stockTokenId": "acme-corp-001",
"underlyingIdentifier": "US0000ACME01",
"allowImport": true,
"tradingMode": "HYBRID",
"auctionIntervalSeconds": 300,
"hybridSwitchSpreadBps": 50,
"auctionRollUnmatched": true,
"mmMakerRebateBps": 5,
"priceRefEnabled": true,
"priceRefMode": "EXTERNAL_FEED",
"priceRefEnforcement": "1MIN",
"priceRefSpreadBps": 200,
"priceRefHaltOnStale": true,
"priceRefStaleTolerance": 300,
"priceRefCircuitBreakerBps": 1000
},
"metadata": {
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2025-01-15T10:30:00.000Z",
"instanceId": "inst_abc"
}
}