Trading
Private

Changed on

Retrieves a list of all open orders that have a specific label within a given currency. This is useful for tracking and managing groups of related orders that share the same label.

Open orders are orders that have been placed but not yet filled or cancelled. The label helps organize and identify related orders.

Scope: trade:read

Try in API console

get/private/get_open_orders_by_label

Request

  • Base URL
    https://test.deribit.com/api/v2
  • URL
    https://test.deribit.com/api/v2/private/get_open_orders_by_label
  • Auth
    none declared

Query parameters

currency'BTC' | 'ETH' | 'USDC' | 'USDT' | 'EURR' required

Currency, i.e "BTC", "ETH", "USDC"

The currency symbol.

📖 Related Article: Using the currency Parameter

labelstring required

user defined label for the order (maximum 64 characters)

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

  • 6e5c000c82a8Revision changes
    • info

      added the optional property // to the response with the status

  • 430b3f0bc67cRevision changes
    • info

      removed the speed_bumped enum value from the // response property for the response status