cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/execute_block_trade \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "private/execute_block_trade",
  "params": {
    "nonce": "bszyprbq",
    "timestamp": 1590485535899,
    "role": "maker",
    "trades": [
      {
        "instrument_name": "BTC-PERPETUAL",
        "direction": "sell",
        "price": 8900,
        "amount": 200000
      },
      {
        "instrument_name": "BTC-28MAY20-9000-C",
        "direction": "sell",
        "amount": 5,
        "price": 0.0133
      }
    ],
    "counterparty_signature": "1590485595899.1Mn52L_Q.lNyNBzXXo-_QBT_wDuMgnhA7uS9tBqdQ5TLN6rxbuoAiQhyaJYGJrm5IV_9enp9niY_x8D60AJLm3yEKPUY1Dv3T0TW0n5-ADPpJF7Fpj0eVDZpZ6QCdX8snBWrSJ0TtqevnO64RCBlN1dIm2T70PP9dlhiqPDAUYI4fpB1vLYI"
  }
}
'

import requests

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

payload = {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "private/execute_block_trade",
    "params": {
        "nonce": "bszyprbq",
        "timestamp": 1590485535899,
        "role": "maker",
        "trades": [
            {
                "instrument_name": "BTC-PERPETUAL",
                "direction": "sell",
                "price": 8900,
                "amount": 200000
            },
            {
                "instrument_name": "BTC-28MAY20-9000-C",
                "direction": "sell",
                "amount": 5,
                "price": 0.0133
            }
        ],
        "counterparty_signature": "1590485595899.1Mn52L_Q.lNyNBzXXo-_QBT_wDuMgnhA7uS9tBqdQ5TLN6rxbuoAiQhyaJYGJrm5IV_9enp9niY_x8D60AJLm3yEKPUY1Dv3T0TW0n5-ADPpJF7Fpj0eVDZpZ6QCdX8snBWrSJ0TtqevnO64RCBlN1dIm2T70PP9dlhiqPDAUYI4fpB1vLYI"
    }
}
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: 1,
    method: 'private/execute_block_trade',
    params: {
      nonce: 'bszyprbq',
      timestamp: 1590485535899,
      role: 'maker',
      trades: [
        {
          instrument_name: 'BTC-PERPETUAL',
          direction: 'sell',
          price: 8900,
          amount: 200000
        },
        {
          instrument_name: 'BTC-28MAY20-9000-C',
          direction: 'sell',
          amount: 5,
          price: 0.0133
        }
      ],
      counterparty_signature: '1590485595899.1Mn52L_Q.lNyNBzXXo-_QBT_wDuMgnhA7uS9tBqdQ5TLN6rxbuoAiQhyaJYGJrm5IV_9enp9niY_x8D60AJLm3yEKPUY1Dv3T0TW0n5-ADPpJF7Fpj0eVDZpZ6QCdX8snBWrSJ0TtqevnO64RCBlN1dIm2T70PP9dlhiqPDAUYI4fpB1vLYI'
    }
  })
};

fetch('https://test.deribit.com/api/v2/private/execute_block_trade', 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/execute_block_trade",
  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' => 1,
    'method' => 'private/execute_block_trade',
    'params' => [
        'nonce' => 'bszyprbq',
        'timestamp' => 1590485535899,
        'role' => 'maker',
        'trades' => [
                [
                                'instrument_name' => 'BTC-PERPETUAL',
                                'direction' => 'sell',
                                'price' => 8900,
                                'amount' => 200000
                ],
                [
                                'instrument_name' => 'BTC-28MAY20-9000-C',
                                'direction' => 'sell',
                                'amount' => 5,
                                'price' => 0.0133
                ]
        ],
        'counterparty_signature' => '1590485595899.1Mn52L_Q.lNyNBzXXo-_QBT_wDuMgnhA7uS9tBqdQ5TLN6rxbuoAiQhyaJYGJrm5IV_9enp9niY_x8D60AJLm3yEKPUY1Dv3T0TW0n5-ADPpJF7Fpj0eVDZpZ6QCdX8snBWrSJ0TtqevnO64RCBlN1dIm2T70PP9dlhiqPDAUYI4fpB1vLYI'
    ]
  ]),
  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/execute_block_trade"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"private/execute_block_trade\",\n  \"params\": {\n    \"nonce\": \"bszyprbq\",\n    \"timestamp\": 1590485535899,\n    \"role\": \"maker\",\n    \"trades\": [\n      {\n        \"instrument_name\": \"BTC-PERPETUAL\",\n        \"direction\": \"sell\",\n        \"price\": 8900,\n        \"amount\": 200000\n      },\n      {\n        \"instrument_name\": \"BTC-28MAY20-9000-C\",\n        \"direction\": \"sell\",\n        \"amount\": 5,\n        \"price\": 0.0133\n      }\n    ],\n    \"counterparty_signature\": \"1590485595899.1Mn52L_Q.lNyNBzXXo-_QBT_wDuMgnhA7uS9tBqdQ5TLN6rxbuoAiQhyaJYGJrm5IV_9enp9niY_x8D60AJLm3yEKPUY1Dv3T0TW0n5-ADPpJF7Fpj0eVDZpZ6QCdX8snBWrSJ0TtqevnO64RCBlN1dIm2T70PP9dlhiqPDAUYI4fpB1vLYI\"\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/execute_block_trade")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"private/execute_block_trade\",\n  \"params\": {\n    \"nonce\": \"bszyprbq\",\n    \"timestamp\": 1590485535899,\n    \"role\": \"maker\",\n    \"trades\": [\n      {\n        \"instrument_name\": \"BTC-PERPETUAL\",\n        \"direction\": \"sell\",\n        \"price\": 8900,\n        \"amount\": 200000\n      },\n      {\n        \"instrument_name\": \"BTC-28MAY20-9000-C\",\n        \"direction\": \"sell\",\n        \"amount\": 5,\n        \"price\": 0.0133\n      }\n    ],\n    \"counterparty_signature\": \"1590485595899.1Mn52L_Q.lNyNBzXXo-_QBT_wDuMgnhA7uS9tBqdQ5TLN6rxbuoAiQhyaJYGJrm5IV_9enp9niY_x8D60AJLm3yEKPUY1Dv3T0TW0n5-ADPpJF7Fpj0eVDZpZ6QCdX8snBWrSJ0TtqevnO64RCBlN1dIm2T70PP9dlhiqPDAUYI4fpB1vLYI\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": 1,\n  \"method\": \"private/execute_block_trade\",\n  \"params\": {\n    \"nonce\": \"bszyprbq\",\n    \"timestamp\": 1590485535899,\n    \"role\": \"maker\",\n    \"trades\": [\n      {\n        \"instrument_name\": \"BTC-PERPETUAL\",\n        \"direction\": \"sell\",\n        \"price\": 8900,\n        \"amount\": 200000\n      },\n      {\n        \"instrument_name\": \"BTC-28MAY20-9000-C\",\n        \"direction\": \"sell\",\n        \"amount\": 5,\n        \"price\": 0.0133\n      }\n    ],\n    \"counterparty_signature\": \"1590485595899.1Mn52L_Q.lNyNBzXXo-_QBT_wDuMgnhA7uS9tBqdQ5TLN6rxbuoAiQhyaJYGJrm5IV_9enp9niY_x8D60AJLm3yEKPUY1Dv3T0TW0n5-ADPpJF7Fpj0eVDZpZ6QCdX8snBWrSJ0TtqevnO64RCBlN1dIm2T70PP9dlhiqPDAUYI4fpB1vLYI\"\n  }\n}"

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

{
  "jsonrpc": "2.0",
  "result": {
    "trades": [
      {
        "trade_seq": 37,
        "trade_id": "92437",
        "timestamp": 1565089523719,
        "tick_direction": 3,
        "state": "filled",
        "price": 0.0001,
        "order_type": "limit",
        "order_id": "343062",
        "matching_id": null,
        "liquidity": "T",
        "iv": 0,
        "instrument_name": "BTC-9AUG19-10250-C",
        "index_price": 11738,
        "fee_currency": "BTC",
        "fee": 0.00025,
        "direction": "sell",
        "block_trade_id": "61",
        "amount": 10
      },
      {
        "trade_seq": 25350,
        "trade_id": "92435",
        "timestamp": 1565089523719,
        "tick_direction": 3,
        "state": "filled",
        "price": 11590,
        "order_type": "limit",
        "order_id": "343058",
        "matching_id": null,
        "liquidity": "T",
        "instrument_name": "BTC-PERPETUAL",
        "index_price": 11737.98,
        "fee_currency": "BTC",
        "fee": 0.00000164,
        "direction": "buy",
        "block_trade_id": "61",
        "amount": 190
      }
    ],
    "timestamp": 1565089523720,
    "id": "61"
  }
}

Block Trade

private/execute_block_trade

Executes a block trade. This is the second step in the block trade workflow - the second party calls this method with the signature received from the first party to execute the trade.

The whole request must be exactly the same as in private/verify_block_trade, only the role field should be set appropriately - this means that both sides have to agree on the same timestamp, nonce, and trades fields, and the server will ensure that the role field is different between sides (each party accepts their own role).

Using the same timestamp and nonce by both sides in private/verify_block_trade ensures that even if unintentionally both sides execute the given block trade with a valid counterparty_signature, the block trade will be executed only once.

Note: In the API, the direction field is always expressed from the maker’s perspective. This means that when you accept a block trade as a taker, the direction shown in the API represents the opposite side of your trade. For example, if you are buying puts as a taker, the API will show the operation as a “sell put” (maker’s perspective), and you will be verifying and accepting a “sell put” block trade.

📖 Related Article: Block Trading

Scope: block_trade:read_write

Try in API console

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/execute_block_trade \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "private/execute_block_trade",
  "params": {
    "nonce": "bszyprbq",
    "timestamp": 1590485535899,
    "role": "maker",
    "trades": [
      {
        "instrument_name": "BTC-PERPETUAL",
        "direction": "sell",
        "price": 8900,
        "amount": 200000
      },
      {
        "instrument_name": "BTC-28MAY20-9000-C",
        "direction": "sell",
        "amount": 5,
        "price": 0.0133
      }
    ],
    "counterparty_signature": "1590485595899.1Mn52L_Q.lNyNBzXXo-_QBT_wDuMgnhA7uS9tBqdQ5TLN6rxbuoAiQhyaJYGJrm5IV_9enp9niY_x8D60AJLm3yEKPUY1Dv3T0TW0n5-ADPpJF7Fpj0eVDZpZ6QCdX8snBWrSJ0TtqevnO64RCBlN1dIm2T70PP9dlhiqPDAUYI4fpB1vLYI"
  }
}
'

import requests

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

payload = {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "private/execute_block_trade",
    "params": {
        "nonce": "bszyprbq",
        "timestamp": 1590485535899,
        "role": "maker",
        "trades": [
            {
                "instrument_name": "BTC-PERPETUAL",
                "direction": "sell",
                "price": 8900,
                "amount": 200000
            },
            {
                "instrument_name": "BTC-28MAY20-9000-C",
                "direction": "sell",
                "amount": 5,
                "price": 0.0133
            }
        ],
        "counterparty_signature": "1590485595899.1Mn52L_Q.lNyNBzXXo-_QBT_wDuMgnhA7uS9tBqdQ5TLN6rxbuoAiQhyaJYGJrm5IV_9enp9niY_x8D60AJLm3yEKPUY1Dv3T0TW0n5-ADPpJF7Fpj0eVDZpZ6QCdX8snBWrSJ0TtqevnO64RCBlN1dIm2T70PP9dlhiqPDAUYI4fpB1vLYI"
    }
}
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: 1,
    method: 'private/execute_block_trade',
    params: {
      nonce: 'bszyprbq',
      timestamp: 1590485535899,
      role: 'maker',
      trades: [
        {
          instrument_name: 'BTC-PERPETUAL',
          direction: 'sell',
          price: 8900,
          amount: 200000
        },
        {
          instrument_name: 'BTC-28MAY20-9000-C',
          direction: 'sell',
          amount: 5,
          price: 0.0133
        }
      ],
      counterparty_signature: '1590485595899.1Mn52L_Q.lNyNBzXXo-_QBT_wDuMgnhA7uS9tBqdQ5TLN6rxbuoAiQhyaJYGJrm5IV_9enp9niY_x8D60AJLm3yEKPUY1Dv3T0TW0n5-ADPpJF7Fpj0eVDZpZ6QCdX8snBWrSJ0TtqevnO64RCBlN1dIm2T70PP9dlhiqPDAUYI4fpB1vLYI'
    }
  })
};

fetch('https://test.deribit.com/api/v2/private/execute_block_trade', 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/execute_block_trade",
  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' => 1,
    'method' => 'private/execute_block_trade',
    'params' => [
        'nonce' => 'bszyprbq',
        'timestamp' => 1590485535899,
        'role' => 'maker',
        'trades' => [
                [
                                'instrument_name' => 'BTC-PERPETUAL',
                                'direction' => 'sell',
                                'price' => 8900,
                                'amount' => 200000
                ],
                [
                                'instrument_name' => 'BTC-28MAY20-9000-C',
                                'direction' => 'sell',
                                'amount' => 5,
                                'price' => 0.0133
                ]
        ],
        'counterparty_signature' => '1590485595899.1Mn52L_Q.lNyNBzXXo-_QBT_wDuMgnhA7uS9tBqdQ5TLN6rxbuoAiQhyaJYGJrm5IV_9enp9niY_x8D60AJLm3yEKPUY1Dv3T0TW0n5-ADPpJF7Fpj0eVDZpZ6QCdX8snBWrSJ0TtqevnO64RCBlN1dIm2T70PP9dlhiqPDAUYI4fpB1vLYI'
    ]
  ]),
  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/execute_block_trade"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"private/execute_block_trade\",\n  \"params\": {\n    \"nonce\": \"bszyprbq\",\n    \"timestamp\": 1590485535899,\n    \"role\": \"maker\",\n    \"trades\": [\n      {\n        \"instrument_name\": \"BTC-PERPETUAL\",\n        \"direction\": \"sell\",\n        \"price\": 8900,\n        \"amount\": 200000\n      },\n      {\n        \"instrument_name\": \"BTC-28MAY20-9000-C\",\n        \"direction\": \"sell\",\n        \"amount\": 5,\n        \"price\": 0.0133\n      }\n    ],\n    \"counterparty_signature\": \"1590485595899.1Mn52L_Q.lNyNBzXXo-_QBT_wDuMgnhA7uS9tBqdQ5TLN6rxbuoAiQhyaJYGJrm5IV_9enp9niY_x8D60AJLm3yEKPUY1Dv3T0TW0n5-ADPpJF7Fpj0eVDZpZ6QCdX8snBWrSJ0TtqevnO64RCBlN1dIm2T70PP9dlhiqPDAUYI4fpB1vLYI\"\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/execute_block_trade")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"private/execute_block_trade\",\n  \"params\": {\n    \"nonce\": \"bszyprbq\",\n    \"timestamp\": 1590485535899,\n    \"role\": \"maker\",\n    \"trades\": [\n      {\n        \"instrument_name\": \"BTC-PERPETUAL\",\n        \"direction\": \"sell\",\n        \"price\": 8900,\n        \"amount\": 200000\n      },\n      {\n        \"instrument_name\": \"BTC-28MAY20-9000-C\",\n        \"direction\": \"sell\",\n        \"amount\": 5,\n        \"price\": 0.0133\n      }\n    ],\n    \"counterparty_signature\": \"1590485595899.1Mn52L_Q.lNyNBzXXo-_QBT_wDuMgnhA7uS9tBqdQ5TLN6rxbuoAiQhyaJYGJrm5IV_9enp9niY_x8D60AJLm3yEKPUY1Dv3T0TW0n5-ADPpJF7Fpj0eVDZpZ6QCdX8snBWrSJ0TtqevnO64RCBlN1dIm2T70PP9dlhiqPDAUYI4fpB1vLYI\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": 1,\n  \"method\": \"private/execute_block_trade\",\n  \"params\": {\n    \"nonce\": \"bszyprbq\",\n    \"timestamp\": 1590485535899,\n    \"role\": \"maker\",\n    \"trades\": [\n      {\n        \"instrument_name\": \"BTC-PERPETUAL\",\n        \"direction\": \"sell\",\n        \"price\": 8900,\n        \"amount\": 200000\n      },\n      {\n        \"instrument_name\": \"BTC-28MAY20-9000-C\",\n        \"direction\": \"sell\",\n        \"amount\": 5,\n        \"price\": 0.0133\n      }\n    ],\n    \"counterparty_signature\": \"1590485595899.1Mn52L_Q.lNyNBzXXo-_QBT_wDuMgnhA7uS9tBqdQ5TLN6rxbuoAiQhyaJYGJrm5IV_9enp9niY_x8D60AJLm3yEKPUY1Dv3T0TW0n5-ADPpJF7Fpj0eVDZpZ6QCdX8snBWrSJ0TtqevnO64RCBlN1dIm2T70PP9dlhiqPDAUYI4fpB1vLYI\"\n  }\n}"

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

{
  "jsonrpc": "2.0",
  "result": {
    "trades": [
      {
        "trade_seq": 37,
        "trade_id": "92437",
        "timestamp": 1565089523719,
        "tick_direction": 3,
        "state": "filled",
        "price": 0.0001,
        "order_type": "limit",
        "order_id": "343062",
        "matching_id": null,
        "liquidity": "T",
        "iv": 0,
        "instrument_name": "BTC-9AUG19-10250-C",
        "index_price": 11738,
        "fee_currency": "BTC",
        "fee": 0.00025,
        "direction": "sell",
        "block_trade_id": "61",
        "amount": 10
      },
      {
        "trade_seq": 25350,
        "trade_id": "92435",
        "timestamp": 1565089523719,
        "tick_direction": 3,
        "state": "filled",
        "price": 11590,
        "order_type": "limit",
        "order_id": "343058",
        "matching_id": null,
        "liquidity": "T",
        "instrument_name": "BTC-PERPETUAL",
        "index_price": 11737.98,
        "fee_currency": "BTC",
        "fee": 0.00000164,
        "direction": "buy",
        "block_trade_id": "61",
        "amount": 190
      }
    ],
    "timestamp": 1565089523720,
    "id": "61"
  }
}

Query Parameters

timestamp

integer

required

Timestamp, shared with other party (milliseconds since the UNIX epoch) The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

nonce

string

required

Nonce

Example:

"bF1_gfgcsd"

role

enum<string>

required

Describes if user wants to be maker or taker of trades Trade role of the user: maker or taker

Available options:

maker,

taker

trades

object[]

required

List of trades for block trade

Hide child attributes

trades.instrument_name

string

Instrument name

Example:

"BTC-PERPETUAL"

trades.price

number

Price for trade

trades.amount

number

It represents the requested trade 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 of trade from the maker perspective

Available options:

buy,

sell

counterparty_signature

string

required

Signature of block trade generated by private/verify_block_trade_method Signature of block trade
It is valid only for 5 minutes around given timestamp

Example:

"1565173369982.1M9tO0Q-.z9n9WyZUU5op9pEz6Jtd2CI71QxQMMsCZAexnIfK9HQRT1pKH3clxeIbY7Bqm-yMcWIoE3IfCDPW5VEdiN-6oS0YkKUyXPD500MUf3ULKhfkmH81EZs"

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

required

Block trade id

Example:

"154"

result.timestamp

integer

required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result.trades

object[]

required

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

string

The name of the application that executed the block trade on behalf of the user (optional).

Example:

"Example Application"

result.broker_code

string

Broker code associated with the broker block trade.

Example:

"2krM7sJsx"

result.broker_name

string

Name of the broker associated with the block trade.

Example:

"Test Broker"

integer

The id that was sent in the request

private/approve_block_trade private/get_block_trade

⌘I