Sign in
Trading
Private

Retrieves the current state of an order identified by its order ID. The response includes order details such as status (open, filled, cancelled), filled amount, remaining amount, price, and other order properties.

Important Note for Mass Quotes: Quote orders are order-like structures that don't fully translate to normal orders. When checking order state for quotes, the amount field represents the remaining amount, not the original order amount.

Note: This method does not support the historical flag and only returns an order that closed within the last 30 minutes (same recency window as historical=false). For orders older than that, use private/get_order_history_by_currency or private/get_order_history_by_instrument with historical=true.

📖 Related Article: Accessing Historical Trades and Orders Using API

Scope: trade:read

Try in API console

get/private/get_order_state

Query parameters

order_idstring required

Unique order identifier

Example:ETH-100234

The order id

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": {
    "order_id": "ETH-100234",
    "instrument_name": "BTC-PERPETUAL",
    "creation_timestamp": 1536569522277,
    "last_update_timestamp": 1536569522277,
    "starbase_last_update_timestamp": 1536569522277000000,
    "block_trade": true,
    "trigger_order_id": "SLIB-370",
    "combo_order_id": "103148386169",
    "starbase_order_id": 103148386170,
    "app_name": "Example Application",
    "mmp_cancelled": true,
    "oto_order_ids": [
      "ETH-100234"
    ],
    "primary_order_id": "ETH-100234"
  }
}

Changes