private/rfq_get_best_quote

POST

private

rfq_get_best_quote

curl --request POST \
  --url https://api.derive.xyz/v3/private/rfq_get_best_quote \
  --header 'Content-Type: application/json' \
  --data '
{
  "subaccount_id": 1,
  "client": "",
  "direction": "buy",
  "extra_fee": "0",
  "legs": [],
  "rfq_id": null
}
'

import requests

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

payload = {
    "subaccount_id": 1,
    "client": "",
    "direction": "buy",
    "extra_fee": "0",
    "legs": [],
    "rfq_id": 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({
    subaccount_id: 1,
    client: '',
    direction: 'buy',
    extra_fee: '0',
    legs: [],
    rfq_id: null
  })
};

fetch('https://api.derive.xyz/v3/private/rfq_get_best_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/rfq_get_best_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([
    'subaccount_id' => 1,
    'client' => '',
    'direction' => 'buy',
    'extra_fee' => '0',
    'legs' => [
        
    ],
    'rfq_id' => 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/rfq_get_best_quote"

	payload := strings.NewReader("{\n  \"subaccount_id\": 1,\n  \"client\": \"\",\n  \"direction\": \"buy\",\n  \"extra_fee\": \"0\",\n  \"legs\": [],\n  \"rfq_id\": 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/rfq_get_best_quote")
  .header("Content-Type", "application/json")
  .body("{\n  \"subaccount_id\": 1,\n  \"client\": \"\",\n  \"direction\": \"buy\",\n  \"extra_fee\": \"0\",\n  \"legs\": [],\n  \"rfq_id\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.derive.xyz/v3/private/rfq_get_best_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  \"subaccount_id\": 1,\n  \"client\": \"\",\n  \"direction\": \"buy\",\n  \"extra_fee\": \"0\",\n  \"legs\": [],\n  \"rfq_id\": null\n}"

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

{
  "direction": "buy",
  "down_liquidation_price": "<string>",
  "estimated_fee": "<string>",
  "estimated_realized_pnl": "<string>",
  "estimated_realized_pnl_excl_fees": "<string>",
  "estimated_total_cost": "<string>",
  "filled_pct": "<string>",
  "is_valid": true,
  "orderbook_total_cost": "<string>",
  "post_initial_margin": "<string>",
  "post_liquidation_price": "<string>",
  "pre_initial_margin": "<string>",
  "suggested_max_fee": "<string>",
  "up_liquidation_price": "<string>",
  "best_quote": {
    "cancel_reason": "",
    "creation_timestamp": 123,
    "direction": "buy",
    "fill_pct": "<string>",
    "last_update_timestamp": 123,
    "legs": [
      {
        "amount": "<string>",
        "direction": "buy",
        "instrument_name": "<string>",
        "price": "<string>"
      }
    ],
    "legs_hash": "<string>",
    "liquidity_role": "maker",
    "quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "rfq_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "open",
    "subaccount_id": 123,
    "wallet": "<string>"
  },
  "invalid_reason": "<string>"
}

Body

application/json

subaccount_id

integer<uint64>

required

Required range: x >= 0

client

string

default:""

direction

enum<string>

default:buy

Available options:

buy,

sell

extra_fee

string<decimal>

default:0

Non-negative decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

legs

object[]

Show child attributes

rfq_id

string<uuid> | null

RFQ ID to get best quote for.

If not provided, will return estimates based on mark prices.

Response

Success

direction

enum<string>

required

Available options:

buy,

sell

down_liquidation_price

string<decimal> | null

required

Optional decimal string of the human value (e.g. "1.5"), up to 12 fractional digits, or null; a string or JSON number is accepted

estimated_fee

string<decimal>

required

Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

estimated_realized_pnl

string<decimal>

required

Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

estimated_realized_pnl_excl_fees

string<decimal>

required

Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

estimated_total_cost

string<decimal>

required

Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

filled_pct

string<decimal>

required

Non-negative decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

is_valid

boolean

required

orderbook_total_cost

string<decimal> | null

required

Optional decimal string of the human value (e.g. "1.5"), up to 12 fractional digits, or null; a string or JSON number is accepted

post_initial_margin

string<decimal>

required

Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

post_liquidation_price

string<decimal> | null

required

Optional decimal string of the human value (e.g. "1.5"), up to 12 fractional digits, or null; a string or JSON number is accepted

pre_initial_margin

string<decimal>

required

Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

suggested_max_fee

string<decimal>

required

Decimal string of the human value (e.g. "1.5"), up to 12 fractional digits; a string or JSON number is accepted

up_liquidation_price

string<decimal> | null

required

Optional decimal string of the human value (e.g. "1.5"), up to 12 fractional digits, or null; a string or JSON number is accepted

best_quote

object | null

Show child attributes

invalid_reason

string | null

private/rfq_get_best_quote

curl --request POST \
  --url https://api.derive.xyz/v3/private/rfq_get_best_quote \
  --header 'Content-Type: application/json' \
  --data '
{
  "subaccount_id": 1,
  "client": "",
  "direction": "buy",
  "extra_fee": "0",
  "legs": [],
  "rfq_id": null
}
'

import requests

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

payload = {
    "subaccount_id": 1,
    "client": "",
    "direction": "buy",
    "extra_fee": "0",
    "legs": [],
    "rfq_id": 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({
    subaccount_id: 1,
    client: '',
    direction: 'buy',
    extra_fee: '0',
    legs: [],
    rfq_id: null
  })
};

fetch('https://api.derive.xyz/v3/private/rfq_get_best_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/rfq_get_best_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([
    'subaccount_id' => 1,
    'client' => '',
    'direction' => 'buy',
    'extra_fee' => '0',
    'legs' => [
        
    ],
    'rfq_id' => 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/rfq_get_best_quote"

	payload := strings.NewReader("{\n  \"subaccount_id\": 1,\n  \"client\": \"\",\n  \"direction\": \"buy\",\n  \"extra_fee\": \"0\",\n  \"legs\": [],\n  \"rfq_id\": 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/rfq_get_best_quote")
  .header("Content-Type", "application/json")
  .body("{\n  \"subaccount_id\": 1,\n  \"client\": \"\",\n  \"direction\": \"buy\",\n  \"extra_fee\": \"0\",\n  \"legs\": [],\n  \"rfq_id\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.derive.xyz/v3/private/rfq_get_best_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  \"subaccount_id\": 1,\n  \"client\": \"\",\n  \"direction\": \"buy\",\n  \"extra_fee\": \"0\",\n  \"legs\": [],\n  \"rfq_id\": null\n}"

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

{
  "direction": "buy",
  "down_liquidation_price": "<string>",
  "estimated_fee": "<string>",
  "estimated_realized_pnl": "<string>",
  "estimated_realized_pnl_excl_fees": "<string>",
  "estimated_total_cost": "<string>",
  "filled_pct": "<string>",
  "is_valid": true,
  "orderbook_total_cost": "<string>",
  "post_initial_margin": "<string>",
  "post_liquidation_price": "<string>",
  "pre_initial_margin": "<string>",
  "suggested_max_fee": "<string>",
  "up_liquidation_price": "<string>",
  "best_quote": {
    "cancel_reason": "",
    "creation_timestamp": 123,
    "direction": "buy",
    "fill_pct": "<string>",
    "last_update_timestamp": 123,
    "legs": [
      {
        "amount": "<string>",
        "direction": "buy",
        "instrument_name": "<string>",
        "price": "<string>"
      }
    ],
    "legs_hash": "<string>",
    "liquidity_role": "maker",
    "quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "rfq_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "open",
    "subaccount_id": 123,
    "wallet": "<string>"
  },
  "invalid_reason": "<string>"
}

HTTP & WS Methods

WS-only Methods

WS Subscriptions

private/rfq_get_best_quote

Body

Response