Skip to main content
GET
/
orderbooks
/
stocks
/
api
/
offchain
/
order-books
/
{orderBookId}
curl -X GET "https://api.trusset.org/orderbooks/stocks/api/offchain/order-books/ob_offchain_001" \
  -H "x-api-key: trusset_{instanceRef}_{secret}"
{
  "success": true,
  "data": {
    "id": "ob_offchain_001",
    "tokenAddress": "0x1234567890abcdef1234567890abcdef12345678",
    "quoteTokenAddress": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd",
    "name": "ACME Corp / EURC (OTC)",
    "symbol": "ACME/EURC",
    "status": "ACTIVE",
    "settlementMode": "OFF_CHAIN",
    "minOrderSize": "1000000000000000000",
    "maxOrderSize": null,
    "tickSize": null,
    "makerFeeBps": 5,
    "takerFeeBps": 15,
    "tokenType": "STOCK_TOKEN",
    "stockTokenId": "acme-corp-001"
  },
  "metadata": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2025-01-15T10:30:00.000Z",
    "instanceId": "inst_abc"
  }
}
Returns the full configuration and status of an off-chain order book. Returns an error if the order book uses on-chain settlement.

Authentication

Requires an instance API key with the trading service enabled.

Path Parameters

orderBookId
string
required
The order book identifier.
curl -X GET "https://api.trusset.org/orderbooks/stocks/api/offchain/order-books/ob_offchain_001" \
  -H "x-api-key: trusset_{instanceRef}_{secret}"
{
  "success": true,
  "data": {
    "id": "ob_offchain_001",
    "tokenAddress": "0x1234567890abcdef1234567890abcdef12345678",
    "quoteTokenAddress": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd",
    "name": "ACME Corp / EURC (OTC)",
    "symbol": "ACME/EURC",
    "status": "ACTIVE",
    "settlementMode": "OFF_CHAIN",
    "minOrderSize": "1000000000000000000",
    "maxOrderSize": null,
    "tickSize": null,
    "makerFeeBps": 5,
    "takerFeeBps": 15,
    "tokenType": "STOCK_TOKEN",
    "stockTokenId": "acme-corp-001"
  },
  "metadata": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2025-01-15T10:30:00.000Z",
    "instanceId": "inst_abc"
  }
}

Error Codes

CodeStatusDescription
ORDER_BOOK_NOT_FOUND404No order book found with this ID
WRONG_SETTLEMENT_MODE400This order book uses on-chain settlement. Use the on-chain API instead.