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-api-key: <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": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "complex_order_ids": {},
  "price": 123,
  "river_id": 123,
  "custom_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expiry_ts_utc": "2023-11-07T05:31:56Z",
  "traded_qty": 0,
  "average_price": 123,
  "fees_paid": 0,
  "reject_reason": "<string>",
  "fills": []
}

Authorizations

x-api-key
string
header
required

API key for programmatic access. Generate one at app.rivermarkets.com under Settings → API Keys.

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: PENDING_SUBMISSION, PROCESSING, RESTING, PARTIALLY_FILLED, EXECUTED, CANCELLED, REJECTED, or EXPIRED

subaccount_id
string<uuid>
required

Subaccount the order belongs to

created_at
string<date-time>
required

Order creation timestamp (UTC)

updated_at
string<date-time>
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)

river_id
integer | null

Instrument ID

custom_asset_id
string<uuid> | null

Custom asset basket UUID

expiry_ts_utc
string<date-time> | 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)

fills
OrderFillResponse · object[]

List of executions (fills) for this order