RFQ
private/simulate_block_trade
Estimates one side of a block trade for the caller’s subaccount before it is signed. Takes the side’s direction, the agreed priced legs and an optional extra_fee. Returns the total fee the side would pay, extra_fee included, its initial margin before and after the trade, and within_price_band, which is whether the total cost is inside the currency’s RFQ price band for both sides, or null if the currency has no band. Fails with invalid_amount (11012) if a leg is smaller than 100 times its instrument’s minimum_amount. A side without enough margin returns is_valid false and the reason, not an error. Requires the block_trade off-chain scope.
POST
/
private
/
simulate_block_trade
private/simulate_block_trade
curl --request POST \
--url https://api.derive.xyz/v3/private/simulate_block_trade \
--header 'Content-Type: application/json' \
--header 'X-DeriveSignature: <api-key>' \
--header 'X-DeriveTimestamp: <api-key>' \
--header 'X-DeriveWallet: <api-key>' \
--data '
{
"legs": [
{
"amount": "<string>",
"instrument_name": "<string>",
"price": "<string>"
}
],
"subaccount_id": 123,
"extra_fee": "0"
}
'import requests
url = "https://api.derive.xyz/v3/private/simulate_block_trade"
payload = {
"legs": [
{
"amount": "<string>",
"instrument_name": "<string>",
"price": "<string>"
}
],
"subaccount_id": 123,
"extra_fee": "0"
}
headers = {
"X-DeriveWallet": "<api-key>",
"X-DeriveTimestamp": "<api-key>",
"X-DeriveSignature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-DeriveWallet': '<api-key>',
'X-DeriveTimestamp': '<api-key>',
'X-DeriveSignature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
legs: [{amount: '<string>', instrument_name: '<string>', price: '<string>'}],
subaccount_id: 123,
extra_fee: '0'
})
};
fetch('https://api.derive.xyz/v3/private/simulate_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://api.derive.xyz/v3/private/simulate_block_trade",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'legs' => [
[
'amount' => '<string>',
'instrument_name' => '<string>',
'price' => '<string>'
]
],
'subaccount_id' => 123,
'extra_fee' => '0'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-DeriveSignature: <api-key>",
"X-DeriveTimestamp: <api-key>",
"X-DeriveWallet: <api-key>"
],
]);
$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://api.derive.xyz/v3/private/simulate_block_trade"
payload := strings.NewReader("{\n \"legs\": [\n {\n \"amount\": \"<string>\",\n \"instrument_name\": \"<string>\",\n \"price\": \"<string>\"\n }\n ],\n \"subaccount_id\": 123,\n \"extra_fee\": \"0\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-DeriveWallet", "<api-key>")
req.Header.Add("X-DeriveTimestamp", "<api-key>")
req.Header.Add("X-DeriveSignature", "<api-key>")
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.post("https://api.derive.xyz/v3/private/simulate_block_trade")
.header("X-DeriveWallet", "<api-key>")
.header("X-DeriveTimestamp", "<api-key>")
.header("X-DeriveSignature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"legs\": [\n {\n \"amount\": \"<string>\",\n \"instrument_name\": \"<string>\",\n \"price\": \"<string>\"\n }\n ],\n \"subaccount_id\": 123,\n \"extra_fee\": \"0\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/private/simulate_block_trade")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-DeriveWallet"] = '<api-key>'
request["X-DeriveTimestamp"] = '<api-key>'
request["X-DeriveSignature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"legs\": [\n {\n \"amount\": \"<string>\",\n \"instrument_name\": \"<string>\",\n \"price\": \"<string>\"\n }\n ],\n \"subaccount_id\": 123,\n \"extra_fee\": \"0\"\n}"
response = http.request(request)
puts response.read_body{
"estimated_fee": "<string>",
"is_valid": true,
"post_initial_margin": "<string>",
"pre_initial_margin": "<string>",
"expires_at_sec": 123,
"invalid_reason": "<string>",
"within_price_band": true
}{
"error": {
"code": 123,
"message": "<string>",
"data": "<string>"
}
}Authorizations
The wallet the request acts for.
The current time in milliseconds, as a decimal string.
EIP-191 signature of the timestamp, by the wallet or one of its session keys.
Body
application/json
This side's direction. The taker side trades opposite the maker side.
Available options:
buy, sell The agreed priced legs, the same on both sides.
Show child attributes
Show child attributes
Broker fee for this side, in USD.
Response
Success
Result for private/simulate_block_trade and private/verify_block_trade: one side's fee and margin if it executed now.
The side's total fee, extra_fee included.
False if the side does not have enough margin for its trade and fees, or if the trade takes the subaccount over its maximum asset count.
Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted
Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted
The last second at which the signed side can execute. Null for an unsigned side.
Whether both sides are within the currency's RFQ price band. Null if it has no band.
private/simulate_block_trade
curl --request POST \
--url https://api.derive.xyz/v3/private/simulate_block_trade \
--header 'Content-Type: application/json' \
--header 'X-DeriveSignature: <api-key>' \
--header 'X-DeriveTimestamp: <api-key>' \
--header 'X-DeriveWallet: <api-key>' \
--data '
{
"legs": [
{
"amount": "<string>",
"instrument_name": "<string>",
"price": "<string>"
}
],
"subaccount_id": 123,
"extra_fee": "0"
}
'import requests
url = "https://api.derive.xyz/v3/private/simulate_block_trade"
payload = {
"legs": [
{
"amount": "<string>",
"instrument_name": "<string>",
"price": "<string>"
}
],
"subaccount_id": 123,
"extra_fee": "0"
}
headers = {
"X-DeriveWallet": "<api-key>",
"X-DeriveTimestamp": "<api-key>",
"X-DeriveSignature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-DeriveWallet': '<api-key>',
'X-DeriveTimestamp': '<api-key>',
'X-DeriveSignature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
legs: [{amount: '<string>', instrument_name: '<string>', price: '<string>'}],
subaccount_id: 123,
extra_fee: '0'
})
};
fetch('https://api.derive.xyz/v3/private/simulate_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://api.derive.xyz/v3/private/simulate_block_trade",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'legs' => [
[
'amount' => '<string>',
'instrument_name' => '<string>',
'price' => '<string>'
]
],
'subaccount_id' => 123,
'extra_fee' => '0'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-DeriveSignature: <api-key>",
"X-DeriveTimestamp: <api-key>",
"X-DeriveWallet: <api-key>"
],
]);
$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://api.derive.xyz/v3/private/simulate_block_trade"
payload := strings.NewReader("{\n \"legs\": [\n {\n \"amount\": \"<string>\",\n \"instrument_name\": \"<string>\",\n \"price\": \"<string>\"\n }\n ],\n \"subaccount_id\": 123,\n \"extra_fee\": \"0\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-DeriveWallet", "<api-key>")
req.Header.Add("X-DeriveTimestamp", "<api-key>")
req.Header.Add("X-DeriveSignature", "<api-key>")
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.post("https://api.derive.xyz/v3/private/simulate_block_trade")
.header("X-DeriveWallet", "<api-key>")
.header("X-DeriveTimestamp", "<api-key>")
.header("X-DeriveSignature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"legs\": [\n {\n \"amount\": \"<string>\",\n \"instrument_name\": \"<string>\",\n \"price\": \"<string>\"\n }\n ],\n \"subaccount_id\": 123,\n \"extra_fee\": \"0\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/private/simulate_block_trade")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-DeriveWallet"] = '<api-key>'
request["X-DeriveTimestamp"] = '<api-key>'
request["X-DeriveSignature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"legs\": [\n {\n \"amount\": \"<string>\",\n \"instrument_name\": \"<string>\",\n \"price\": \"<string>\"\n }\n ],\n \"subaccount_id\": 123,\n \"extra_fee\": \"0\"\n}"
response = http.request(request)
puts response.read_body{
"estimated_fee": "<string>",
"is_valid": true,
"post_initial_margin": "<string>",
"pre_initial_margin": "<string>",
"expires_at_sec": 123,
"invalid_reason": "<string>",
"within_price_band": true
}{
"error": {
"code": 123,
"message": "<string>",
"data": "<string>"
}
}