Sign in

v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Combo Books
Matching Engine
Private

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

get/private/create_combo

Query parameters

instrument_namestring

Unique instrument identifier

amountnumber

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.

direction'buy' | 'sell'

Direction: buy, or sell

List of trades used to create a combo

[
  {
    "instrument_name": "BTC-PERPETUAL"
  }
]

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": {
    "id": "BTC-FS-31DEC21-PERP",
    "state_timestamp": 1536569522277,
    "creation_timestamp": 1536569522277,
    "legs": [
      {
        "instrument_name": "BTC-PERPETUAL",
        "amount": -1
      }
    ]
  }
}