Sign in
Trading

Get order

Returns a single order by ID.

get/orders/{order_id}

Path parameters

order_idstring required

Order identifier.

Response

Order returned successfully.

order_idstring
client_order_idstring
marketstring
side'buy' | 'sell'
type'limit' | 'market' | 'stop_limit' | 'stop_market'
pricestring nullable

Null for market orders.

quantitystring
filledstring
remainingstring
status'open' | 'partially_filled' | 'filled' | 'cancelled' | 'rejected'
time_in_force'GTC' | 'IOC' | 'FOK'
created_atinteger
updated_atinteger
cancelled_atinteger nullable

Present when the order has been cancelled.

Example response

{
  "order_id": "order-001",
  "client_order_id": "my-order-1",
  "market": "BTCZAR",
  "side": "buy",
  "type": "limit",
  "price": "1020000",
  "quantity": "10000000",
  "filled": "0",
  "remaining": "10000000",
  "status": "open",
  "time_in_force": "GTC",
  "created_at": 1710000000,
  "updated_at": 1710000001,
  "cancelled_at": 1710000100
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.