Skip to main content
GET
/
orderbooks
/
stocks
/
api
/
offchain
/
order-books
curl -X GET "https://api.trusset.org/orderbooks/stocks/api/offchain/order-books?status=ACTIVE" \
  -H "x-api-key: trusset_{instanceRef}_{secret}"
{
  "success": true,
  "data": [
    {
      "id": "ob_offchain_001",
      "name": "ACME Corp / EURC (OTC)",
      "symbol": "ACME/EURC",
      "status": "ACTIVE",
      "settlementMode": "OFF_CHAIN"
    }
  ],
  "metadata": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2025-01-15T10:30:00.000Z",
    "instanceId": "inst_abc"
  }
}
Returns all off-chain order books belonging to the authenticated instance. Only books with settlementMode: OFF_CHAIN are included.

Authentication

Requires an instance API key with the trading service enabled.

Query Parameters

status
string
Filter by order book status. One of ACTIVE, PAUSED, or CLOSED.
curl -X GET "https://api.trusset.org/orderbooks/stocks/api/offchain/order-books?status=ACTIVE" \
  -H "x-api-key: trusset_{instanceRef}_{secret}"
{
  "success": true,
  "data": [
    {
      "id": "ob_offchain_001",
      "name": "ACME Corp / EURC (OTC)",
      "symbol": "ACME/EURC",
      "status": "ACTIVE",
      "settlementMode": "OFF_CHAIN"
    }
  ],
  "metadata": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2025-01-15T10:30:00.000Z",
    "instanceId": "inst_abc"
  }
}