Skip to main content
GET
xo-orderbook-client-rs

Authorizations

XO_API_KEY
string
header
required

L2 HMAC request signature. See Authentication.

Path Parameters

id
string
required

Response

OK

id
string
required

Numeric order id, serialised as a string for SDK compatibility (py-clob-client reads id as str).

market
string
required

conditionId

asset_id
string
required

Decimal U256 token id (the canonical CLOB asset_id). Empty string when the gateway has no MarketInfo registered for the order's market.

outcome
enum<string>
required
Available options:
Yes,
No
side
enum<string>
required
Available options:
BUY,
SELL
price
string
required

Trimmed decimal (signed-order price).

original_size
string
required

Signed makerAmount/takerAmount converted to human shares.

size_matched
string
required

Cumulative fills so far, human shares.

status
enum<string>
required
Available options:
live,
delayed
created_at
integer<int64>
required

Unix seconds, bare integer (NOT stringified).

order_hash
string
required

0x-prefixed keccak256 of the EIP-712 typed-data digest.

maker_address
string
required

Wallet address (0x-prefixed hex) that placed the order.

owner
string<uuid>
required

UUIDv5 of the authenticated owner (deterministic from maker_address via XO_WALLET_OWNER_NAMESPACE). Stable across sessions — integrators can pre-compute the mapping.

expiration
string
required

Unix seconds as decimal string. "0" = no expiry (GTC).

order_type
enum<string>
required
Available options:
GTC,
GTD,
FOK,
FAK