Retrieves the state of recent orders that have a specific label. This is useful for tracking orders that share the same label, which is helpful for managing related orders.

Results are filtered by currency and label. The response includes order details such as status, filled amount, remaining amount, and other order properties for all orders with the specified label.

Note: This method does not support the historical flag and only returns orders that closed within the last 30 minutes (same recency window as historical=false). This also applies to a trigger order and the order it creates upon triggering — once either has been closed for more than 30 minutes, it will no longer appear here, even though the same label was carried over between them. 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

{
  "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"
    }
  ]
}