Skip to main content
GET
/
v1
/
orders
/
{order_id}
Get Order
curl --request GET \
  --url https://api.rivermarkets.com/v1/orders/{order_id} \
  --header 'X-River-Key-Id: <api-key>' \
  --header 'X-River-Signature: <api-key>' \
  --header 'X-River-Timestamp: <api-key>'
{
  "river_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_type": "<string>",
  "time_in_force": "<string>",
  "qty": 123,
  "buy_flag": true,
  "status": "<string>",
  "subaccount_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "<string>",
  "updated_at": "<string>",
  "complex_order_ids": {},
  "price": 123,
  "post_only": false,
  "river_id": 123,
  "generic_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expiry_ts_utc": "<string>",
  "traded_qty": 0,
  "average_price": 123,
  "fees_paid": 0,
  "reject_reason": "<string>",
  "parent_iceberg_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent_peg_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fills": []
}

Documentation Index

Fetch the complete documentation index at: https://docs.rivermarkets.com/llms.txt

Use this file to discover all available pages before exploring further.

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 order detail response including fills.

​
river_order_id
string<uuid>
required

Unique order identifier

​
order_type
string
required

Order type: LIMIT or MARKET

​
time_in_force
string
required

Time in force: FOK, GTC, GTD, or IOC

​
qty
number
required

Original order quantity

​
buy_flag
boolean
required

Order direction: true=buy, false=sell

​
status
string
required

Order status. Live: PENDING_SUBMISSION, PROCESSING, RESTING. Terminal: EXECUTED, PARTIALLY_FILLED (cancelled with some fills), CANCELLED, REJECTED.

​
subaccount_id
string<uuid>
required

Subaccount the order belongs to

​
created_at
string
required

Order creation timestamp (UTC)

​
updated_at
string
required

Last update timestamp (UTC)

​
complex_order_ids
Complex Order Ids · object
required

List of complex river orders id

​
price
number | null

Limit price (null for market orders)

​
post_only
boolean
default:false

Whether the order is post-only (maker-only)

​
river_id
integer | null

Instrument ID

​
generic_asset_id
string<uuid> | null

Generic asset basket UUID

​
expiry_ts_utc
string | null

Expiry timestamp in UTC for GTD orders

​
traded_qty
number
default:0

Total quantity filled

​
average_price
number | null

Volume-weighted average fill price

​
fees_paid
number
default:0

Total fees paid across all fills

​
reject_reason
string | null

Reason for rejection (if status is REJECTED)

​
parent_iceberg_order_id
string<uuid> | null

If this order is a tranche of an iceberg parent, the parent's id; otherwise null.

​
parent_peg_order_id
string<uuid> | null

If this order is the resting child of a peg parent, the parent's id; otherwise null.

​
fills
OrderFillResponse · object[]

List of executions (fills) for this order