Get Order by Client Order ID

#Endpoint

GET /v1/client/order/{client_order_id}

Mainnet: https://api.orderly.org/v1/client/order/{client_order_id}

Testnet: https://testnet-api.orderly.org/v1/client/order/{client_order_id}

Rate limit: 10 requests per second.

Returns the details for one order selected by its client_order_id.

#Authentication

Send the signed-request headers.

• orderly-timestamp — required; signed-request timestamp in milliseconds.
• orderly-account-id — required; authenticated account ID.
• orderly-key — required; public API key.
• orderly-signature — required; signature generated for the request.

#Path parameter

client_order_id (string, required) — the client-defined identifier of the order.

#Response

HTTP 200 — application/json.

success is a required boolean. data is a required object containing the order details. timestamp is the server response time in milliseconds.

• order_id (number, required); user_id (number, required).
• price (number, required); type (string, required); quantity (number, required); amount (number or null, required).
• total_executed_quantity (number, required); visible_quantity (number, required); symbol (string, required); side (string, required).
• status (string, required): NEW, FILLED, PARTIAL_FILLED, or CANCELLED.
• total_fee (number, required) — aggregate fees across executed trades, including custom trading fees. Use trade-level fields for reconciliation; this value is not a builder or affiliate payout basis. fee_asset (string, required).
• client_order_id (number or null, required); average_executed_price (number, required).
• created_time, updated_time (numbers, required; millisecond timestamps); realized_pnl (number, required).
• executed_quantity, visible, and executed (numbers, optional).
• reduce_only (boolean or null, optional).
• order_tag (string or null, optional) — the full stored tag, up to 128 characters. Current custom-fee tags use enum:<owning_broker_id>:<enum_id>; historical orders can retain the legacy enum:<enum_id> form, which should not be rewritten. For PangoPerps, a current-format example is enum:pangoperps:GRID_PRO.
• margin_mode (string, optional), such as CROSS.

{
  "success": true,
  "data": {
    "order_id": 78151,
    "user_id": 12345,
    "price": 0.67772,
    "type": "LIMIT",
    "quantity": 20,
    "amount": 10,
    "total_executed_quantity": 20,
    "visible_quantity": 1,
    "symbol": "PERP_WOO_USDC",
    "side": "BUY",
    "status": "FILLED",
    "total_fee": 0.5,
    "fee_asset": "WOO",
    "client_order_id": 1,
    "average_executed_price": 0.67772,
    "created_time": 1653563963000,
    "updated_time": 1653564213000,
    "realized_pnl": 0,
    "executed_quantity": 20,
    "visible": 1,
    "executed": 20,
    "reduce_only": null,
    "order_tag": "enum:pangoperps:GRID_PRO",
    "margin_mode": "CROSS"
  },
  "timestamp": 1702989203989
}

The order body and optional execution details are available through the response fields above.