private/create_combo

Verifies and creates a combo book or returns an existing combo matching the given trades. Combos allow trading on multiple instruments (futures and options) simultaneously as a single strategy.

If a combo matching the provided trades already exists, this method returns the existing combo. Otherwise, it creates a new combo book with the specified leg structure.

Scope: trade:read_write

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/create_combo \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 6,
  "method": "private/create_combo",
  "params": {
    "trades": [
      {
        "instrument_name": "BTC-29APR22-37500-C",
        "amount": "1",
        "direction": "buy"
      },
      {
        "instrument_name": "BTC-29APR22-37500-P",
        "amount": "1",
        "direction": "sell"
      }
    ]
  }
}
'

200

{
  "jsonrpc": "2.0",
  "id": 6,
  "result": {
    "state_timestamp": 1650960943922,
    "state": "active",
    "legs": [
      {
        "instrument_name": "BTC-29APR22-37500-C",
        "amount": 1
      },
      {
        "instrument_name": "BTC-29APR22-37500-P",
        "amount": -1
      }
    ],
    "id": "BTC-REV-29APR22-37500",
    "instrument_id": 52,
    "creation_timestamp": 1650960943000
  }
}

Query Parameters

trades · object[] · required

List of trades used to create a combo

Hide child attributes

trades. instrument_name · string

Unique instrument identifier

Example:

"BTC-PERPETUAL"

trades. amount · number

It represents the requested order size. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin.

trades. direction · enum<string>

Direction: buy, or sell

Available options: buy, sell

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