Skip to main content
GET
Get Order Queue Position

Authorizations

X-River-Key-Id
string
header
required

UUID of your API key (from Settings → API Keys).

X-River-Timestamp
string
header
required

Current unix seconds. Must be within 30s of server time.

X-River-Signature
string
header
required

Base64 Ed25519 signature over the canonical request: METHOD\nPATH\nSORTED_QUERY\nTIMESTAMP\nSHA256(body) hex. See /api-reference/authentication for the full recipe.

Path Parameters

order_id
string<uuid>
required

Response

Successful Response

Schema for the queue-position response of an order.

river_order_id
string<uuid>
required

River order identifier

exchange_order_id
string
required

Exchange order ID with the best (minimum) queue priority

queue_position
number
required

Number of preceding shares in the queue ahead of this order (lower is better priority)