Sign in

v2

latestOpenAPI 3.1.0Proprietary2026-08-054985119.4 KB
orders

Get Order

Get a single order by ID with its fills.

Returns complete order details including execution history.

Use Cases:

  • Track order progress and execution quality
  • Reconcile fills for accounting
  • Debug rejected or partially filled orders
get/v1/orders/{order_id}

Path parameters

order_idstring uuid required

Response

Successful Response

river_order_idstring uuid required

Unique order identifier

order_typestring required

Order type: LIMIT or MARKET

time_in_forcestring required

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

qtynumber required

Original order quantity

pricenumber nullable

Limit price (null for market orders)

buy_flagboolean required

Order direction: true=buy, false=sell

post_onlyboolean

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

cancel_order_on_pauseboolean

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

statusstring required

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

river_idinteger nullable

Instrument ID

generic_asset_idstring uuid nullable

Generic asset basket UUID

subaccount_idstring uuid required

Subaccount the order belongs to

expiry_ts_utcstring nullable

Expiry timestamp in UTC for GTD orders

created_atstring required

Order creation timestamp (UTC)

updated_atstring required

Last update timestamp (UTC)

traded_qtynumber

Total quantity filled

average_pricenumber nullable

Volume-weighted average fill price

fees_paidnumber

Total fees paid across all fills

complex_order_idsobject required

List of complex river orders id

reject_reasonstring nullable

Reason for rejection (if status is REJECTED)

parent_iceberg_order_idstring uuid nullable

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

parent_peg_order_idstring uuid nullable

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

parent_smart_taker_order_idstring uuid nullable

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