Estimate the cost and margin impact of an order

POST

private

order_quote

curl --request POST \
  --url https://api.derive.xyz/v3/private/order_quote \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "<string>",
  "instrument_name": "<string>",
  "limit_price": "<string>",
  "max_fee": "<string>",
  "nonce": "<string>",
  "signature": "<string>",
  "signature_expiry_sec": 123,
  "signer": "<string>",
  "subaccount_id": 123,
  "client": "",
  "extra_fee": null,
  "is_atomic_signing": false,
  "label": "",
  "mmp": false,
  "order_type": "limit",
  "reduce_only": false,
  "referral_code": "",
  "reject_post_only": true,
  "reject_timestamp": 9223372036854776000,
  "time_in_force": "gtc",
  "trigger_price": null
}
'

import requests

url = "https://api.derive.xyz/v3/private/order_quote"

payload = {
    "amount": "<string>",
    "instrument_name": "<string>",
    "limit_price": "<string>",
    "max_fee": "<string>",
    "nonce": "<string>",
    "signature": "<string>",
    "signature_expiry_sec": 123,
    "signer": "<string>",
    "subaccount_id": 123,
    "client": "",
    "extra_fee": None,
    "is_atomic_signing": False,
    "label": "",
    "mmp": False,
    "order_type": "limit",
    "reduce_only": False,
    "referral_code": "",
    "reject_post_only": True,
    "reject_timestamp": 9223372036854776000,
    "time_in_force": "gtc",
    "trigger_price": None
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: '<string>',
    instrument_name: '<string>',
    limit_price: '<string>',
    max_fee: '<string>',
    nonce: '<string>',
    signature: '<string>',
    signature_expiry_sec: 123,
    signer: '<string>',
    subaccount_id: 123,
    client: '',
    extra_fee: null,
    is_atomic_signing: false,
    label: '',
    mmp: false,
    order_type: 'limit',
    reduce_only: false,
    referral_code: '',
    reject_post_only: true,
    reject_timestamp: 9223372036854776000,
    time_in_force: 'gtc',
    trigger_price: null
  })
};

fetch('https://api.derive.xyz/v3/private/order_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://api.derive.xyz/v3/private/order_quote",
  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([
    'amount' => '<string>',
    'instrument_name' => '<string>',
    'limit_price' => '<string>',
    'max_fee' => '<string>',
    'nonce' => '<string>',
    'signature' => '<string>',
    'signature_expiry_sec' => 123,
    'signer' => '<string>',
    'subaccount_id' => 123,
    'client' => '',
    'extra_fee' => null,
    'is_atomic_signing' => false,
    'label' => '',
    'mmp' => false,
    'order_type' => 'limit',
    'reduce_only' => false,
    'referral_code' => '',
    'reject_post_only' => true,
    'reject_timestamp' => 9223372036854776000,
    'time_in_force' => 'gtc',
    'trigger_price' => null
  ]),
  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://api.derive.xyz/v3/private/order_quote"

	payload := strings.NewReader("{\n  \"amount\": \"<string>\",\n  \"instrument_name\": \"<string>\",\n  \"limit_price\": \"<string>\",\n  \"max_fee\": \"<string>\",\n  \"nonce\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"signature_expiry_sec\": 123,\n  \"signer\": \"<string>\",\n  \"subaccount_id\": 123,\n  \"client\": \"\",\n  \"extra_fee\": null,\n  \"is_atomic_signing\": false,\n  \"label\": \"\",\n  \"mmp\": false,\n  \"order_type\": \"limit\",\n  \"reduce_only\": false,\n  \"referral_code\": \"\",\n  \"reject_post_only\": true,\n  \"reject_timestamp\": 9223372036854776000,\n  \"time_in_force\": \"gtc\",\n  \"trigger_price\": null\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.derive.xyz/v3/private/order_quote")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"<string>\",\n  \"instrument_name\": \"<string>\",\n  \"limit_price\": \"<string>\",\n  \"max_fee\": \"<string>\",\n  \"nonce\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"signature_expiry_sec\": 123,\n  \"signer\": \"<string>\",\n  \"subaccount_id\": 123,\n  \"client\": \"\",\n  \"extra_fee\": null,\n  \"is_atomic_signing\": false,\n  \"label\": \"\",\n  \"mmp\": false,\n  \"order_type\": \"limit\",\n  \"reduce_only\": false,\n  \"referral_code\": \"\",\n  \"reject_post_only\": true,\n  \"reject_timestamp\": 9223372036854776000,\n  \"time_in_force\": \"gtc\",\n  \"trigger_price\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.derive.xyz/v3/private/order_quote")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"<string>\",\n  \"instrument_name\": \"<string>\",\n  \"limit_price\": \"<string>\",\n  \"max_fee\": \"<string>\",\n  \"nonce\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"signature_expiry_sec\": 123,\n  \"signer\": \"<string>\",\n  \"subaccount_id\": 123,\n  \"client\": \"\",\n  \"extra_fee\": null,\n  \"is_atomic_signing\": false,\n  \"label\": \"\",\n  \"mmp\": false,\n  \"order_type\": \"limit\",\n  \"reduce_only\": false,\n  \"referral_code\": \"\",\n  \"reject_post_only\": true,\n  \"reject_timestamp\": 9223372036854776000,\n  \"time_in_force\": \"gtc\",\n  \"trigger_price\": null\n}"

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

{
  "estimated_fee": "<string>",
  "estimated_fill_amount": "<string>",
  "estimated_fill_price": "<string>",
  "estimated_realized_pnl": "<string>",
  "estimated_realized_pnl_excl_fees": "<string>",
  "is_valid": true,
  "post_initial_margin": "<string>",
  "pre_initial_margin": "<string>",
  "suggested_max_fee": "<string>",
  "invalid_reason": "<string>",
  "max_amount": "<string>",
  "post_liquidation_price": "<string>"
}

Body

application/json

Parameters for public/order_quote and private/order_quote.

amount

string<decimal>

required

Order amount in units of the base, as a decimal string (e.g. "1.5") or a JSON number.

direction

enum<string>

required

Order direction

Available options:

buy,

sell

instrument_name

string

required

Instrument name

limit_price

string<decimal>

required

Limit price in quote currency, as a decimal string or a JSON number.

max_fee

string<decimal>

required

Max fee per unit of volume in quote currency, as a decimal string or a JSON number.

nonce

string

required

Nonce.

signature

string

required

Ethereum signature of the order.

signature_expiry_sec

integer<int64>

required

Signature expiry (unix seconds).

signer

string

required

Owner wallet or session key that signed the order.

subaccount_id

integer<int64>

required

Subaccount ID

client

string

default:""

extra_fee

string<decimal> | null

Optional extra fee per unit of volume, as a decimal string or JSON number. Defaults to zero.

is_atomic_signing

boolean

default:false

label

string

default:""

mmp

boolean

default:false

order_type

enum<string>

default:limit

Available options:

limit,

market

reduce_only

boolean

default:false

referral_code

string

default:""

reject_post_only

boolean

default:true

reject_timestamp

integer<int64>

default:9223372036854776000

time_in_force

enum<string>

default:gtc

Available options:

gtc,

post_only,

fok,

ioc

trigger_price

string<decimal> | null

Trigger price as a decimal string or JSON number; omit for non-trigger orders.

trigger_price_type

enum<string> | null

Available options:

mark,

index

trigger_type

enum<string> | null

Available options:

stoploss,

takeprofit

Response

Success

Estimated fill price, fees, and resulting margin for a proposed order — a non-binding dry-run. All price, fee, and margin fields are decimal strings.

estimated_fee

string

required

estimated_fill_amount

string

required

estimated_fill_price

string

required

estimated_order_status

enum<string>

required

Available options:

open,

filled,

rejected,

cancelled,

expired,

untriggered,

algo_active

estimated_realized_pnl

string

required

estimated_realized_pnl_excl_fees

string

required

is_valid

boolean

required

post_initial_margin

string

required

pre_initial_margin

string

required

suggested_max_fee

string

required

invalid_reason

string | null

max_amount

string | null

post_liquidation_price

string | null

Preview an order's EIP-712 signing data

Cancel an existing order and place a new one

⌘I

Estimate the cost and margin impact of an order

curl --request POST \
  --url https://api.derive.xyz/v3/private/order_quote \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "<string>",
  "instrument_name": "<string>",
  "limit_price": "<string>",
  "max_fee": "<string>",
  "nonce": "<string>",
  "signature": "<string>",
  "signature_expiry_sec": 123,
  "signer": "<string>",
  "subaccount_id": 123,
  "client": "",
  "extra_fee": null,
  "is_atomic_signing": false,
  "label": "",
  "mmp": false,
  "order_type": "limit",
  "reduce_only": false,
  "referral_code": "",
  "reject_post_only": true,
  "reject_timestamp": 9223372036854776000,
  "time_in_force": "gtc",
  "trigger_price": null
}
'

import requests

url = "https://api.derive.xyz/v3/private/order_quote"

payload = {
    "amount": "<string>",
    "instrument_name": "<string>",
    "limit_price": "<string>",
    "max_fee": "<string>",
    "nonce": "<string>",
    "signature": "<string>",
    "signature_expiry_sec": 123,
    "signer": "<string>",
    "subaccount_id": 123,
    "client": "",
    "extra_fee": None,
    "is_atomic_signing": False,
    "label": "",
    "mmp": False,
    "order_type": "limit",
    "reduce_only": False,
    "referral_code": "",
    "reject_post_only": True,
    "reject_timestamp": 9223372036854776000,
    "time_in_force": "gtc",
    "trigger_price": None
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: '<string>',
    instrument_name: '<string>',
    limit_price: '<string>',
    max_fee: '<string>',
    nonce: '<string>',
    signature: '<string>',
    signature_expiry_sec: 123,
    signer: '<string>',
    subaccount_id: 123,
    client: '',
    extra_fee: null,
    is_atomic_signing: false,
    label: '',
    mmp: false,
    order_type: 'limit',
    reduce_only: false,
    referral_code: '',
    reject_post_only: true,
    reject_timestamp: 9223372036854776000,
    time_in_force: 'gtc',
    trigger_price: null
  })
};

fetch('https://api.derive.xyz/v3/private/order_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://api.derive.xyz/v3/private/order_quote",
  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([
    'amount' => '<string>',
    'instrument_name' => '<string>',
    'limit_price' => '<string>',
    'max_fee' => '<string>',
    'nonce' => '<string>',
    'signature' => '<string>',
    'signature_expiry_sec' => 123,
    'signer' => '<string>',
    'subaccount_id' => 123,
    'client' => '',
    'extra_fee' => null,
    'is_atomic_signing' => false,
    'label' => '',
    'mmp' => false,
    'order_type' => 'limit',
    'reduce_only' => false,
    'referral_code' => '',
    'reject_post_only' => true,
    'reject_timestamp' => 9223372036854776000,
    'time_in_force' => 'gtc',
    'trigger_price' => null
  ]),
  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://api.derive.xyz/v3/private/order_quote"

	payload := strings.NewReader("{\n  \"amount\": \"<string>\",\n  \"instrument_name\": \"<string>\",\n  \"limit_price\": \"<string>\",\n  \"max_fee\": \"<string>\",\n  \"nonce\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"signature_expiry_sec\": 123,\n  \"signer\": \"<string>\",\n  \"subaccount_id\": 123,\n  \"client\": \"\",\n  \"extra_fee\": null,\n  \"is_atomic_signing\": false,\n  \"label\": \"\",\n  \"mmp\": false,\n  \"order_type\": \"limit\",\n  \"reduce_only\": false,\n  \"referral_code\": \"\",\n  \"reject_post_only\": true,\n  \"reject_timestamp\": 9223372036854776000,\n  \"time_in_force\": \"gtc\",\n  \"trigger_price\": null\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.derive.xyz/v3/private/order_quote")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"<string>\",\n  \"instrument_name\": \"<string>\",\n  \"limit_price\": \"<string>\",\n  \"max_fee\": \"<string>\",\n  \"nonce\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"signature_expiry_sec\": 123,\n  \"signer\": \"<string>\",\n  \"subaccount_id\": 123,\n  \"client\": \"\",\n  \"extra_fee\": null,\n  \"is_atomic_signing\": false,\n  \"label\": \"\",\n  \"mmp\": false,\n  \"order_type\": \"limit\",\n  \"reduce_only\": false,\n  \"referral_code\": \"\",\n  \"reject_post_only\": true,\n  \"reject_timestamp\": 9223372036854776000,\n  \"time_in_force\": \"gtc\",\n  \"trigger_price\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.derive.xyz/v3/private/order_quote")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"<string>\",\n  \"instrument_name\": \"<string>\",\n  \"limit_price\": \"<string>\",\n  \"max_fee\": \"<string>\",\n  \"nonce\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"signature_expiry_sec\": 123,\n  \"signer\": \"<string>\",\n  \"subaccount_id\": 123,\n  \"client\": \"\",\n  \"extra_fee\": null,\n  \"is_atomic_signing\": false,\n  \"label\": \"\",\n  \"mmp\": false,\n  \"order_type\": \"limit\",\n  \"reduce_only\": false,\n  \"referral_code\": \"\",\n  \"reject_post_only\": true,\n  \"reject_timestamp\": 9223372036854776000,\n  \"time_in_force\": \"gtc\",\n  \"trigger_price\": null\n}"

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

{
  "estimated_fee": "<string>",
  "estimated_fill_amount": "<string>",
  "estimated_fill_price": "<string>",
  "estimated_realized_pnl": "<string>",
  "estimated_realized_pnl_excl_fees": "<string>",
  "is_valid": true,
  "post_initial_margin": "<string>",
  "pre_initial_margin": "<string>",
  "suggested_max_fee": "<string>",
  "invalid_reason": "<string>",
  "max_amount": "<string>",
  "post_liquidation_price": "<string>"
}

HTTP & WS Methods

WS-only Methods

WS Subscriptions

Estimate the cost and margin impact of an order

Body

Response