Skip to main content
GET
Get Order

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)

cancel_order_on_pause
boolean
default:true

Kalshi only: whether the exchange cancels the resting order during a trading pause

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.

parent_smart_taker_order_id
string<uuid> | null

If this order is an IOC child of a smart-taker parent, the parent's id; otherwise null.

fills
OrderFillResponse · object[]

List of executions (fills) for this order