DEderibit
Trading
Private

Changed on

Retrieves a list of all open orders for a specific instrument. Open orders are orders that have been placed but not yet filled or cancelled.

Results can be filtered by order type. This method is useful for checking active orders for a particular instrument.

Scope: trade:read

Try in API console

get/private/get_open_orders_by_instrument

Request

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

Query parameters

instrument_namestring required

Unique instrument identifier

Example:BTC-PERPETUAL

Instrument name

type'all' | 'limit' | 'trigger_all' | 'stop_all' | 'stop_limit' | 'stop_market' | 'take_all' | 'take_limit' | 'take_market' | 'trailing_all' | 'trailing_stop' | 'one_triggers_one_cancels_other' | 'one_triggers_other' | 'one_cancels_other' | 'one_cancels_or_triggers_other'

Order-type filter, including regular, trigger and linked-order families.

Order type, default - all

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

  • 82518876f388Revision changes
    • info

      added the new enum value one_cancels_or_triggers_other to the query request parameter type

    • info

      added the new enum value one_cancels_other to the query request parameter type

    • info

      added the new enum value one_triggers_one_cancels_other to the query request parameter type

    • info

      added the new enum value one_triggers_other to the query request parameter type

  • bee2616f5f18Revision changes
    • info

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