Skip to main content
GET
Shares resting ahead of an order (price-time priority)

Authorizations

DX-ACCESS-KEY
string
header
required

The public API key (alphanumeric access_key string).

DX-ACCESS-TIMESTAMP
string
header
required

Request timestamp, Unix milliseconds (decimal). ±5000 ms replay window.

DX-ACCESS-SIGNATURE
string
header
required

base64(HMAC-SHA256(secret, "timestamp\nMETHOD\npath?query\nbody")). For the WS handshake the body is empty and the path is /v1/ws.

Path Parameters

order_id
string
required

A u64-domain value rendered as a decimal string.

Pattern: ^[0-9]+$
Example:

"182390"

Response

Shares ahead under price-time priority.

Shares resting ahead under price-time priority.

shares_ahead
string
required

Sum of remaining size ahead at this order's YES-space level.

Pattern: ^[0-9]+$
Example:

"182390"

as_of_seq
string
required

A u64-domain value rendered as a decimal string.

Pattern: ^[0-9]+$
Example:

"182390"