cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/mass_quote \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 7859,
  "method": "private/mass_quote",
  "params": {
    "detailed": true,
    "quote_id": "1",
    "mmp_group": "default",
    "quotes": [
      {
        "instrument_name": "BTC-PERPETUAL",
        "quote_set_id": "futures",
        "ask": {
          "price": 43800,
          "amount": 10
        },
        "bid": {
          "price": 43700,
          "amount": 10
        }
      },
      {
        "instrument_name": "BTC-22DEC23-41600-C",
        "quote_set_id": "options",
        "ask": {
          "price": 0.05,
          "amount": 1
        },
        "bid": {
          "price": 0.04,
          "amount": 1
        }
      }
    ]
  }
}
'

import requests

url = "https://test.deribit.com/api/v2/private/mass_quote"

payload = {
    "jsonrpc": "2.0",
    "id": 7859,
    "method": "private/mass_quote",
    "params": {
        "detailed": True,
        "quote_id": "1",
        "mmp_group": "default",
        "quotes": [
            {
                "instrument_name": "BTC-PERPETUAL",
                "quote_set_id": "futures",
                "ask": {
                    "price": 43800,
                    "amount": 10
                },
                "bid": {
                    "price": 43700,
                    "amount": 10
                }
            },
            {
                "instrument_name": "BTC-22DEC23-41600-C",
                "quote_set_id": "options",
                "ask": {
                    "price": 0.05,
                    "amount": 1
                },
                "bid": {
                    "price": 0.04,
                    "amount": 1
                }
            }
        ]
    }
}
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 7859,
    method: 'private/mass_quote',
    params: {
      detailed: true,
      quote_id: '1',
      mmp_group: 'default',
      quotes: [
        {
          instrument_name: 'BTC-PERPETUAL',
          quote_set_id: 'futures',
          ask: {price: 43800, amount: 10},
          bid: {price: 43700, amount: 10}
        },
        {
          instrument_name: 'BTC-22DEC23-41600-C',
          quote_set_id: 'options',
          ask: {price: 0.05, amount: 1},
          bid: {price: 0.04, amount: 1}
        }
      ]
    }
  })
};

fetch('https://test.deribit.com/api/v2/private/mass_quote', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.deribit.com/api/v2/private/mass_quote",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    'jsonrpc' => '2.0',
    'id' => 7859,
    'method' => 'private/mass_quote',
    'params' => [
        'detailed' => true,
        'quote_id' => '1',
        'mmp_group' => 'default',
        'quotes' => [
                [
                                'instrument_name' => 'BTC-PERPETUAL',
                                'quote_set_id' => 'futures',
                                'ask' => [
                                                                'price' => 43800,
                                                                'amount' => 10
                                ],
                                'bid' => [
                                                                'price' => 43700,
                                                                'amount' => 10
                                ]
                ],
                [
                                'instrument_name' => 'BTC-22DEC23-41600-C',
                                'quote_set_id' => 'options',
                                'ask' => [
                                                                'price' => 0.05,
                                                                'amount' => 1
                                ],
                                'bid' => [
                                                                'price' => 0.04,
                                                                'amount' => 1
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.deribit.com/api/v2/private/mass_quote"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 7859,\n  \"method\": \"private/mass_quote\",\n  \"params\": {\n    \"detailed\": true,\n    \"quote_id\": \"1\",\n    \"mmp_group\": \"default\",\n    \"quotes\": [\n      {\n        \"instrument_name\": \"BTC-PERPETUAL\",\n        \"quote_set_id\": \"futures\",\n        \"ask\": {\n          \"price\": 43800,\n          \"amount\": 10\n        },\n        \"bid\": {\n          \"price\": 43700,\n          \"amount\": 10\n        }\n      },\n      {\n        \"instrument_name\": \"BTC-22DEC23-41600-C\",\n        \"quote_set_id\": \"options\",\n        \"ask\": {\n          \"price\": 0.05,\n          \"amount\": 1\n        },\n        \"bid\": {\n          \"price\": 0.04,\n          \"amount\": 1\n        }\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://test.deribit.com/api/v2/private/mass_quote")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 7859,\n  \"method\": \"private/mass_quote\",\n  \"params\": {\n    \"detailed\": true,\n    \"quote_id\": \"1\",\n    \"mmp_group\": \"default\",\n    \"quotes\": [\n      {\n        \"instrument_name\": \"BTC-PERPETUAL\",\n        \"quote_set_id\": \"futures\",\n        \"ask\": {\n          \"price\": 43800,\n          \"amount\": 10\n        },\n        \"bid\": {\n          \"price\": 43700,\n          \"amount\": 10\n        }\n      },\n      {\n        \"instrument_name\": \"BTC-22DEC23-41600-C\",\n        \"quote_set_id\": \"options\",\n        \"ask\": {\n          \"price\": 0.05,\n          \"amount\": 1\n        },\n        \"bid\": {\n          \"price\": 0.04,\n          \"amount\": 1\n        }\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.deribit.com/api/v2/private/mass_quote")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 7859,\n  \"method\": \"private/mass_quote\",\n  \"params\": {\n    \"detailed\": true,\n    \"quote_id\": \"1\",\n    \"mmp_group\": \"default\",\n    \"quotes\": [\n      {\n        \"instrument_name\": \"BTC-PERPETUAL\",\n        \"quote_set_id\": \"futures\",\n        \"ask\": {\n          \"price\": 43800,\n          \"amount\": 10\n        },\n        \"bid\": {\n          \"price\": 43700,\n          \"amount\": 10\n        }\n      },\n      {\n        \"instrument_name\": \"BTC-22DEC23-41600-C\",\n        \"quote_set_id\": \"options\",\n        \"ask\": {\n          \"price\": 0.05,\n          \"amount\": 1\n        },\n        \"bid\": {\n          \"price\": 0.04,\n          \"amount\": 1\n        }\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "jsonrpc": "2.0",
  "id": 7859,
  "result": {
    "errors": [
      {
        "instrument_name": "BTC-PERPETUAL",
        "side": "bid",
        "error": {
          "message": "price_too_high 43666.4288",
          "code": 10007
        }
      }
    ],
    "orders": [
      {
        "is_liquidation": false,
        "reduce_only": false,
        "risk_reducing": false,
        "last_update_timestamp": 1703162550180,
        "creation_timestamp": 1703162478689,
        "filled_amount": 0,
        "average_price": 0,
        "order_type": "limit",
        "order_state": "open",
        "quote": true,
        "quote_set_id": "options",
        "quote_id": "1",
        "post_only": false,
        "replaced": false,
        "mmp_group": "default",
        "web": false,
        "mmp": true,
        "api": false,
        "instrument_name": "BTC-22DEC23-41600-C",
        "order_id": "6653852",
        "max_show": 1,
        "time_in_force": "good_til_cancelled",
        "price": 0.04,
        "direction": "buy",
        "amount": 1,
        "label": ""
      },
      {
        "is_liquidation": false,
        "reduce_only": false,
        "risk_reducing": false,
        "last_update_timestamp": 1703162550180,
        "creation_timestamp": 1703162478689,
        "filled_amount": 0,
        "average_price": 0,
        "order_type": "limit",
        "order_state": "open",
        "quote": true,
        "quote_set_id": "options",
        "quote_id": "1",
        "post_only": false,
        "replaced": false,
        "mmp_group": "default",
        "web": false,
        "mmp": true,
        "api": false,
        "instrument_name": "BTC-22DEC23-41600-C",
        "order_id": "6653853",
        "max_show": 1,
        "time_in_force": "good_til_cancelled",
        "price": 0.05,
        "direction": "sell",
        "amount": 1,
        "label": ""
      },
      {
        "is_liquidation": false,
        "reduce_only": false,
        "risk_reducing": false,
        "last_update_timestamp": 1703162550180,
        "creation_timestamp": 1703162478689,
        "filled_amount": 0,
        "average_price": 0,
        "order_type": "limit",
        "order_state": "open",
        "quote": true,
        "quote_set_id": "futures",
        "quote_id": "1",
        "post_only": false,
        "replaced": false,
        "mmp_group": "default",
        "web": false,
        "mmp": true,
        "api": false,
        "instrument_name": "BTC-PERPETUAL",
        "order_id": "6653855",
        "max_show": 10,
        "time_in_force": "good_til_cancelled",
        "price": 43800,
        "direction": "sell",
        "amount": 10,
        "label": ""
      }
    ],
    "trades": []
  }
}

Trading

private/mass_quote

Places buy and/or sell orders (quotes) on one or more instruments simultaneously. This method is designed for market makers who need to quote on multiple instruments efficiently.

Requirements:

Cancel-on-Disconnect must be enabled (see private/enable_cancel_on_disconnect), otherwise the request will return an error.
This endpoint can only be used after approval from the administrators.

Each quote can include both bid and ask sides, or just one side. Quotes are identified by quote_set_id for targeted cancellation. Use the wait_for_response parameter to control whether to wait for all orders to be processed before returning.

📖 Related Article: Mass Quotes Specifications

Scope: trade:read_write

Try in API console

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/mass_quote \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 7859,
  "method": "private/mass_quote",
  "params": {
    "detailed": true,
    "quote_id": "1",
    "mmp_group": "default",
    "quotes": [
      {
        "instrument_name": "BTC-PERPETUAL",
        "quote_set_id": "futures",
        "ask": {
          "price": 43800,
          "amount": 10
        },
        "bid": {
          "price": 43700,
          "amount": 10
        }
      },
      {
        "instrument_name": "BTC-22DEC23-41600-C",
        "quote_set_id": "options",
        "ask": {
          "price": 0.05,
          "amount": 1
        },
        "bid": {
          "price": 0.04,
          "amount": 1
        }
      }
    ]
  }
}
'

import requests

url = "https://test.deribit.com/api/v2/private/mass_quote"

payload = {
    "jsonrpc": "2.0",
    "id": 7859,
    "method": "private/mass_quote",
    "params": {
        "detailed": True,
        "quote_id": "1",
        "mmp_group": "default",
        "quotes": [
            {
                "instrument_name": "BTC-PERPETUAL",
                "quote_set_id": "futures",
                "ask": {
                    "price": 43800,
                    "amount": 10
                },
                "bid": {
                    "price": 43700,
                    "amount": 10
                }
            },
            {
                "instrument_name": "BTC-22DEC23-41600-C",
                "quote_set_id": "options",
                "ask": {
                    "price": 0.05,
                    "amount": 1
                },
                "bid": {
                    "price": 0.04,
                    "amount": 1
                }
            }
        ]
    }
}
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 7859,
    method: 'private/mass_quote',
    params: {
      detailed: true,
      quote_id: '1',
      mmp_group: 'default',
      quotes: [
        {
          instrument_name: 'BTC-PERPETUAL',
          quote_set_id: 'futures',
          ask: {price: 43800, amount: 10},
          bid: {price: 43700, amount: 10}
        },
        {
          instrument_name: 'BTC-22DEC23-41600-C',
          quote_set_id: 'options',
          ask: {price: 0.05, amount: 1},
          bid: {price: 0.04, amount: 1}
        }
      ]
    }
  })
};

fetch('https://test.deribit.com/api/v2/private/mass_quote', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.deribit.com/api/v2/private/mass_quote",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    'jsonrpc' => '2.0',
    'id' => 7859,
    'method' => 'private/mass_quote',
    'params' => [
        'detailed' => true,
        'quote_id' => '1',
        'mmp_group' => 'default',
        'quotes' => [
                [
                                'instrument_name' => 'BTC-PERPETUAL',
                                'quote_set_id' => 'futures',
                                'ask' => [
                                                                'price' => 43800,
                                                                'amount' => 10
                                ],
                                'bid' => [
                                                                'price' => 43700,
                                                                'amount' => 10
                                ]
                ],
                [
                                'instrument_name' => 'BTC-22DEC23-41600-C',
                                'quote_set_id' => 'options',
                                'ask' => [
                                                                'price' => 0.05,
                                                                'amount' => 1
                                ],
                                'bid' => [
                                                                'price' => 0.04,
                                                                'amount' => 1
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.deribit.com/api/v2/private/mass_quote"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 7859,\n  \"method\": \"private/mass_quote\",\n  \"params\": {\n    \"detailed\": true,\n    \"quote_id\": \"1\",\n    \"mmp_group\": \"default\",\n    \"quotes\": [\n      {\n        \"instrument_name\": \"BTC-PERPETUAL\",\n        \"quote_set_id\": \"futures\",\n        \"ask\": {\n          \"price\": 43800,\n          \"amount\": 10\n        },\n        \"bid\": {\n          \"price\": 43700,\n          \"amount\": 10\n        }\n      },\n      {\n        \"instrument_name\": \"BTC-22DEC23-41600-C\",\n        \"quote_set_id\": \"options\",\n        \"ask\": {\n          \"price\": 0.05,\n          \"amount\": 1\n        },\n        \"bid\": {\n          \"price\": 0.04,\n          \"amount\": 1\n        }\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://test.deribit.com/api/v2/private/mass_quote")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 7859,\n  \"method\": \"private/mass_quote\",\n  \"params\": {\n    \"detailed\": true,\n    \"quote_id\": \"1\",\n    \"mmp_group\": \"default\",\n    \"quotes\": [\n      {\n        \"instrument_name\": \"BTC-PERPETUAL\",\n        \"quote_set_id\": \"futures\",\n        \"ask\": {\n          \"price\": 43800,\n          \"amount\": 10\n        },\n        \"bid\": {\n          \"price\": 43700,\n          \"amount\": 10\n        }\n      },\n      {\n        \"instrument_name\": \"BTC-22DEC23-41600-C\",\n        \"quote_set_id\": \"options\",\n        \"ask\": {\n          \"price\": 0.05,\n          \"amount\": 1\n        },\n        \"bid\": {\n          \"price\": 0.04,\n          \"amount\": 1\n        }\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.deribit.com/api/v2/private/mass_quote")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 7859,\n  \"method\": \"private/mass_quote\",\n  \"params\": {\n    \"detailed\": true,\n    \"quote_id\": \"1\",\n    \"mmp_group\": \"default\",\n    \"quotes\": [\n      {\n        \"instrument_name\": \"BTC-PERPETUAL\",\n        \"quote_set_id\": \"futures\",\n        \"ask\": {\n          \"price\": 43800,\n          \"amount\": 10\n        },\n        \"bid\": {\n          \"price\": 43700,\n          \"amount\": 10\n        }\n      },\n      {\n        \"instrument_name\": \"BTC-22DEC23-41600-C\",\n        \"quote_set_id\": \"options\",\n        \"ask\": {\n          \"price\": 0.05,\n          \"amount\": 1\n        },\n        \"bid\": {\n          \"price\": 0.04,\n          \"amount\": 1\n        }\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "jsonrpc": "2.0",
  "id": 7859,
  "result": {
    "errors": [
      {
        "instrument_name": "BTC-PERPETUAL",
        "side": "bid",
        "error": {
          "message": "price_too_high 43666.4288",
          "code": 10007
        }
      }
    ],
    "orders": [
      {
        "is_liquidation": false,
        "reduce_only": false,
        "risk_reducing": false,
        "last_update_timestamp": 1703162550180,
        "creation_timestamp": 1703162478689,
        "filled_amount": 0,
        "average_price": 0,
        "order_type": "limit",
        "order_state": "open",
        "quote": true,
        "quote_set_id": "options",
        "quote_id": "1",
        "post_only": false,
        "replaced": false,
        "mmp_group": "default",
        "web": false,
        "mmp": true,
        "api": false,
        "instrument_name": "BTC-22DEC23-41600-C",
        "order_id": "6653852",
        "max_show": 1,
        "time_in_force": "good_til_cancelled",
        "price": 0.04,
        "direction": "buy",
        "amount": 1,
        "label": ""
      },
      {
        "is_liquidation": false,
        "reduce_only": false,
        "risk_reducing": false,
        "last_update_timestamp": 1703162550180,
        "creation_timestamp": 1703162478689,
        "filled_amount": 0,
        "average_price": 0,
        "order_type": "limit",
        "order_state": "open",
        "quote": true,
        "quote_set_id": "options",
        "quote_id": "1",
        "post_only": false,
        "replaced": false,
        "mmp_group": "default",
        "web": false,
        "mmp": true,
        "api": false,
        "instrument_name": "BTC-22DEC23-41600-C",
        "order_id": "6653853",
        "max_show": 1,
        "time_in_force": "good_til_cancelled",
        "price": 0.05,
        "direction": "sell",
        "amount": 1,
        "label": ""
      },
      {
        "is_liquidation": false,
        "reduce_only": false,
        "risk_reducing": false,
        "last_update_timestamp": 1703162550180,
        "creation_timestamp": 1703162478689,
        "filled_amount": 0,
        "average_price": 0,
        "order_type": "limit",
        "order_state": "open",
        "quote": true,
        "quote_set_id": "futures",
        "quote_id": "1",
        "post_only": false,
        "replaced": false,
        "mmp_group": "default",
        "web": false,
        "mmp": true,
        "api": false,
        "instrument_name": "BTC-PERPETUAL",
        "order_id": "6653855",
        "max_show": 10,
        "time_in_force": "good_til_cancelled",
        "price": 43800,
        "direction": "sell",
        "amount": 10,
        "label": ""
      }
    ],
    "trades": []
  }
}

Query Parameters

wait_for_response

boolean

If false, the response is sent immediately after the risk check. If true, the response is sent after the orders all go through the matching engine. Default - true.

detailed

boolean

Flag to receive a list of all order changes and a list of errors, or to only receive a list of errors. Default - false.

Example:

true

quote_id

string

required

Identifier of a mass quote message. Can be used to match trades to requests. We recommend using an incrementing counter.

Example:

"1"

mmp_group

string

required

Name of the MMP group. An MMP group has to be used and only one quote can exist per instrument per side per MMP group.

Example:

"default"

valid_until

integer

Timestamp, when provided server will start processing request in Matching Engine only before given timestamp, in other cases timed_out error will be responded. Remember that the given timestamp should be consistent with the server's time, use /public/time method to obtain current server time.

quotes

object[]

required

List of quotes.

Hide child attributes

quotes.instrument_name

string

The name of the instrument.

quotes.quote_set_id

string

User-defined label that can be used for targeted cancels using private/cancel_quotes.

quotes.ask

object

Order details for the ask. If not provided, bid must be present.

Hide child attributes

quotes.ask.price

number

The price of this side of the quote. If no price is supplied, only the amount is amended.

quotes.ask.amount

number

The amount of this side of the quote. If no quantity is supplied, only the price is amended.

quotes.ask.post_only

boolean

default:false

If true, the order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just below the spread. Default - false

quotes.ask.reject_post_only

boolean

default:false

If an order is considered post-only and this field is set to true then the order is put to the order book unmodified or the request is rejected. Only valid in combination with "post_only" set to true. Default value - false

quotes.bid

object

Order details for the bid. If not provided, ask must be present.

Hide child attributes

quotes.bid.price

number

The price of this side of the quote. If no price is supplied, only the amount is amended.

quotes.bid.amount

number

The amount of this side of the quote. If no quantity is supplied, only the price is amended.

quotes.bid.post_only

boolean

default:false

If true, the order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just below the spread. Default - false

quotes.bid.reject_post_only

boolean

default:false

Example:

[
  {
    "instrument_name": "BTC-PERPETUAL",
    "quote_set_id": "futures",
    "ask": { "price": 43800, "amount": 10 },
    "bid": { "price": 43700, "amount": 10 }
  },
  {
    "instrument_name": "BTC-22DEC23-41600-C",
    "quote_set_id": "options",
    "ask": { "price": 0.05, "amount": 1 },
    "bid": { "price": 0.04, "amount": 1 }
  }
]

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.orders

object[]

Hide child attributes

result.orders.order_id

string

required

Unique order identifier

Example:

"ETH-100234"

result.orders.order_state

enum<string>

required

Order state: "open", "filled", "rejected", "cancelled", "untriggered"

Available options:

open,

filled,

rejected,

cancelled,

untriggered,

triggered

result.orders.order_type

enum<string>

required

Order type: "limit", "market", "stop_limit", "stop_market", "take_limit", "take_market", "trailing_stop"

Available options:

market,

limit,

stop_market,

stop_limit,

take_market,

take_limit,

trailing_stop

result.orders.time_in_force

enum<string>

required

Order time in force: "good_til_cancelled", "good_til_day", "fill_or_kill" or "immediate_or_cancel"

Available options:

good_til_cancelled,

good_til_day,

fill_or_kill,

immediate_or_cancel

result.orders.instrument_name

string

required

Unique instrument identifier

Example:

"BTC-PERPETUAL"

result.orders.creation_timestamp

integer

required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result.orders.last_update_timestamp

integer

required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result.orders.direction

enum<string>

required

Direction: buy, or sell

Available options:

buy,

sell

result.orders.price

required

Price in base currency or "market_price" in case of open trigger market orders

result.orders.label

string

required

User defined label (up to 64 characters)

result.orders.post_only

boolean

required

true for post-only orders only

result.orders.api

boolean

required

true if created with API

result.orders.original_order_type

enum<string>

Original order type. Optional field

Available options:

market,

market_limit

result.orders.is_rebalance

boolean

Optional (only for spot). true if order was automatically created during cross-collateral balance restoration

result.orders.is_liquidation

boolean

Optional (not added for spot). true if order was automatically created during liquidation

result.orders.reject_post_only

boolean

true if order has reject_post_only flag (field is present only when post_only is true)

result.orders.reduce_only

boolean

Optional (not added for spot). 'true for reduce-only orders only'

result.orders.web

boolean

true if created via Deribit frontend (optional)

result.orders.mobile

boolean

Optional field with value true added only when created with Mobile Application

result.orders.refresh_amount

number

The initial display amount of iceberg order. Iceberg order display amount will be refreshed to that value after match consuming actual display amount. Absent for other types of orders

result.orders.display_amount

number

The actual display amount of iceberg order. Absent for other types of orders.

result.orders.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.

result.orders.contracts

number

It represents the order size in contract units. (Optional, may be absent in historical data).

result.orders.filled_amount

number

Filled amount of the order. For perpetual and futures the filled_amount is in USD units, for options - in units or corresponding cryptocurrency contracts, e.g., BTC or ETH.

result.orders.average_price

number

Average fill price of the order

result.orders.advanced

enum<string>

advanced type: "usd" or "implv" (Only for options; field is omitted if not applicable).

Available options:

usd,

implv

result.orders.implv

number

Implied volatility in percent. (Only if advanced="implv")

result.orders.usd

number

Option price in USD (Only if advanced="usd")

result.orders.triggered

boolean

Whether the trigger order has been triggered

result.orders.trigger

enum<string>

Trigger type (only for trigger orders). Allowed values: "index_price", "mark_price", "last_price".

Available options:

index_price,

mark_price,

last_price

result.orders.trigger_price

number

Trigger price (Only for future trigger orders)

result.orders.trigger_offset

number

The maximum deviation from the price peak beyond which the order will be triggered (Only for trailing trigger orders)

result.orders.trigger_reference_price

number

The price of the given trigger at the time when the order was placed (Only for trailing trigger orders)

result.orders.block_trade

boolean

true if order made from block_trade trade, added only in that case.

Example:

true

result.orders.mmp

boolean

true if the order is a MMP order, otherwise false.

result.orders.risk_reducing

boolean

true if the order is marked by the platform as a risk reducing order (can apply only to orders placed by PM users), otherwise false.

result.orders.replaced

boolean

true if the order was edited (by user or - in case of advanced options orders - by pricing engine), otherwise false.

result.orders.auto_replaced

boolean

Options, advanced orders only - true if last modification of the order was performed by the pricing engine, otherwise false.

result.orders.quote

boolean

If order is a quote. Present only if true.

result.orders.mmp_group

string

Name of the MMP group supplied in the private/mass_quote request. Only present for quote orders.

result.orders.quote_set_id

string

Identifier of the QuoteSet supplied in the private/mass_quote request. Only present for quote orders.

result.orders.quote_id

string

The same QuoteID as supplied in the private/mass_quote request. Only present for quote orders.

result.orders.trigger_order_id

string

Id of the trigger order that created the order (Only for orders that were created by triggered orders).

Example:

"SLIB-370"

result.orders.combo_order_id

string

Id of the combo order that created this order (only present for orders that were created as legs of a combo order).

Example:

"103148386169"

result.orders.app_name

string

The name of the application that placed the order on behalf of the user (optional).

Example:

"Example Application"

result.orders.mmp_cancelled

boolean

true if order was cancelled by mmp trigger (optional)

Example:

true

result.orders.cancel_reason

enum<string>

Enumerated reason behind cancel "user_request", "autoliquidation", "cancel_on_disconnect", "risk_mitigation", "pme_risk_reduction" (portfolio margining risk reduction), "pme_account_locked" (portfolio margining account locked per currency), "position_locked", "mmp_trigger" (market maker protection), "mmp_config_curtailment" (market maker configured quantity decreased), "edit_post_only_reject" (cancelled on edit because of reject_post_only setting), "oco_other_closed" (the oco order linked to this order was closed), "oto_primary_closed" (the oto primary order that was going to trigger this order was cancelled), "settlement" (closed because of a settlement)

Available options:

user_request,

autoliquidation,

cancel_on_disconnect,

risk_mitigation,

pme_risk_reduction,

pme_account_locked,

position_locked,

mmp_trigger,

mmp_config_curtailment,

edit_post_only_reject,

oco_other_closed,

oto_primary_closed,

settlement

result.orders.oto_order_ids

string[]

The Ids of the orders that will be triggered if the order is filled

Order Id

result.orders.trigger_fill_condition

enum<string>

The fill condition of the linked order (Only for linked order types), default: `first_hit`.

`"first_hit"` - any execution of the primary order will fully cancel/place all secondary orders.
`"complete_fill"` - a complete execution (meaning the primary order no longer exists) will cancel/place the secondary orders.
`"incremental"` - any fill of the primary order will cause proportional partial cancellation/placement of the secondary order. The amount that will be subtracted/added to the secondary order will be rounded down to the contract size.

Available options:

first_hit,

complete_fill,

incremental

result.orders.oco_ref

string

Unique reference that identifies a one_cancels_others (OCO) pair.

result.orders.primary_order_id

string

ID of the order that triggered this order.

Example:

"ETH-100234"

result.orders.is_secondary_oto

boolean

true if the order is an order that can be triggered by another order, otherwise not present.

result.orders.is_primary_otoco

boolean

true if the order is an order that can trigger an OCO pair, otherwise not present.

result.trades

object[]

Hide child attributes

result.trades.trade_id

string

required

Unique (per currency) trade identifier

result.trades.trade_seq

integer

required

The sequence number of the trade within instrument

result.trades.instrument_name

string

required

Unique instrument identifier

Example:

"BTC-PERPETUAL"

result.trades.timestamp

integer

required

The timestamp of the trade (milliseconds since the UNIX epoch)

Example:

1517329113791

result.trades.order_id

string

required

Id of the user order (maker or taker), i.e. subscriber's order id that took part in the trade

result.trades.matching_id

string

required

Always null

result.trades.direction

enum<string>

required

Trade direction of the taker

Available options:

buy,

sell

result.trades.tick_direction

enum<integer>

required

Direction of the "tick" (0 = Plus Tick, 1 = Zero-Plus Tick, 2 = Minus Tick, 3 = Zero-Minus Tick).

Available options:

0,

1,

2,

3

result.trades.index_price

number

required

Index Price at the moment of trade

result.trades.price

number

required

The price of the trade

result.trades.amount

number

required

Trade amount. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin.

result.trades.fee

number

required

User's fee in units of the specified fee_currency

result.trades.fee_currency

enum<string>

required

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

Available options:

BTC,

ETH,

USDC,

USDT,

EURR

result.trades.state

enum<string>

required

Order state: "open", "filled", "rejected", "cancelled", "untriggered" or "archive" (if order was archived)

Available options:

open,

filled,

rejected,

cancelled,

untriggered,

archive

result.trades.mark_price

number

required

Mark Price at the moment of trade

result.trades.order_type

enum<string>

Order type: "limit, "market", or "liquidation"

Available options:

limit,

market,

liquidation

result.trades.advanced

enum<string>

Advanced type of user order: "usd" or "implv" (only for options; omitted if not applicable)

Available options:

usd,

implv

result.trades.contracts

number

Trade size in contract units (optional, may be absent in historical trades)

result.trades.iv

number

Option implied volatility for the price (Option only)

result.trades.underlying_price

number

Underlying price for implied volatility calculations (Options only)

result.trades.liquidation

enum<string>

Optional field (only for trades caused by liquidation): "M" when maker side of trade was under liquidation, "T" when taker side was under liquidation, "MT" when both sides of trade were under liquidation

Available options:

M,

T,

MT

result.trades.liquidity

enum<string>

Describes what was role of users order: "M" when it was maker order, "T" when it was taker order

Available options:

M,

T

result.trades.label

string

User defined label (presented only when previously set for order by user)

result.trades.block_trade_id

string

Block trade id - when trade was part of a block trade

Example:

"154"

result.trades.block_rfq_id

integer

ID of the Block RFQ - when trade was part of the Block RFQ

result.trades.block_rfq_quote_id

integer

ID of the Block RFQ quote - when trade was part of the Block RFQ

result.trades.reduce_only

string

true if user order is reduce-only

result.trades.post_only

string

true if user order is post-only

result.trades.mmp

boolean

true if user order is MMP

result.trades.risk_reducing

boolean

true if user order is marked by the platform as a risk reducing order (can apply only to orders placed by PM users)

result.trades.api

boolean

true if user order was created with API

result.trades.profit_loss

number

Profit and loss in base currency.

result.trades.legs

array

Optional field containing leg trades if trade is a combo trade (present when querying for only combo trades and in combo_trades events)

result.trades.combo_id

string

Optional field containing combo instrument name if the trade is a combo trade

result.trades.combo_trade_id

string

Optional field containing combo trade identifier if the trade is a combo trade

result.trades.quote_set_id

string

QuoteSet of the user order (optional, present only for orders placed with private/mass_quote)

result.trades.quote_id

string

QuoteID of the user order (optional, present only for orders placed with private/mass_quote)

result.trades.trade_allocations

object[]

List of allocations for Block RFQ pre-allocation. Each allocation specifies user_id, amount, and fee for the allocated part of the trade. For broker client allocations, a client_info object will be included.

Hide child attributes

result.trades.trade_allocations.amount

number

required

Amount allocated to this user.

result.trades.trade_allocations.fee

number

required

Fee for the allocated part of the trade.

result.trades.trade_allocations.user_id

integer

User ID to which part of the trade is allocated. For brokers the User ID is obstructed.

result.trades.trade_allocations.client_info

object

Optional client allocation info for brokers.

Hide child attributes

result.trades.trade_allocations.client_info.client_id

integer

ID of a client; available to broker. Represents a group of users under a common name.

result.trades.trade_allocations.client_info.client_link_id

integer

ID assigned to a single user in a client; available to broker.

result.trades.trade_allocations.client_info.name

string

Name of the linked user within the client; available to broker.

result.errors_count

integer

Number of errors (present when detailed : false).

result.pending_requests_count

integer

Number of pending quotes (present when wait_for_response: false and detailed : false).

result.pending_requests

object[]

List of pending quotes (present when wait_for_response: false and detailed : true).

Hide child attributes

result.pending_requests.instrument_name

string

Instrument name.

result.pending_requests.side

string

Quote side - bid or ask.

result.errors

object[]

List of errors (present when detailed : true).

Hide child attributes

result.errors.instrument_name

string

Instrument name.

result.errors.side

string

Quote side - bid or ask.

result.errors.error

object

Error data.

result.errors.code

integer

Error code

result.errors.message

string

Error message.

integer

The id that was sent in the request

private/get_user_trades_by_order private/move_positions

⌘I