public/get_combos

Retrieves information about active combos for the specified currency. Returns detailed information including leg structures and combo properties.

For a list of combo IDs only, use public/get_combo_ids. For details about a specific combo, use public/get_combo_details.

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/public/get_combos \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "public/get_combos",
  "params": {
    "currency": "BTC"
  }
}
'

200

{
  "jsonrpc": "2.0",
  "id": 2,
  "result": [
    {
      "state_timestamp": 1650636265101,
      "state": "active",
      "legs": [
        {
          "instrument_name": "BTC-29APR22-39300-C",
          "amount": 1
        },
        {
          "instrument_name": "BTC-29APR22-39600-C",
          "amount": -1
        }
      ],
      "id": "BTC-CS-29APR22-39300_39600",
      "instrument_id": 28,
      "creation_timestamp": 1650636235000
    },
    {
      "state_timestamp": 1650620605150,
      "state": "active",
      "legs": [
        {
          "instrument_name": "BTC-PERPETUAL",
          "amount": -1
        },
        {
          "instrument_name": "BTC-29APR22",
          "amount": 1
        }
      ],
      "id": "BTC-FS-29APR22_PERP",
      "instrument_id": 27,
      "creation_timestamp": 1650620575000
    }
  ]
}

Query Parameters

currency · enum<string> · required

The currency symbol or "any" for all Currency name or "any" if don't care

Available options: BTC, ETH, USDC, USDT, EURR, any

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object[] · required

Hide child attributes

result. id · string

Unique combo identifier

Example:

"BTC-FS-31DEC21-PERP"

result. instrument_id · integer

Instrument ID

result. state · enum<string>

Combo state: "active", "inactive"

Available options: active, inactive

result. state_timestamp · integer

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result. creation_timestamp · integer

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result. legs · object[]

Hide child attributes

result.legs. instrument_name · string

Unique instrument identifier

Example:

"BTC-PERPETUAL"

result.legs. amount · integer

Size multiplier of a leg. A negative value indicates that the trades on given leg are in opposite direction to the combo trades they originate from

Example:

-1

id · integer

The id that was sent in the request