Create a request for quote (RFQ)

POST

private

send_rfq

curl --request POST \
  --url https://api.derive.xyz/v3/private/send_rfq \
  --header 'Content-Type: application/json' \
  --data '
{
  "legs": "<unknown>",
  "subaccount_id": 1,
  "client": "",
  "counterparties": null,
  "extra_fee": "0",
  "label": "",
  "max_total_cost": null,
  "min_total_cost": null,
  "partial_fill_step": "1",
  "referral_code": ""
}
'

import requests

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

payload = {
    "legs": "<unknown>",
    "subaccount_id": 1,
    "client": "",
    "counterparties": None,
    "extra_fee": "0",
    "label": "",
    "max_total_cost": None,
    "min_total_cost": None,
    "partial_fill_step": "1",
    "referral_code": ""
}
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({
    legs: '<unknown>',
    subaccount_id: 1,
    client: '',
    counterparties: null,
    extra_fee: '0',
    label: '',
    max_total_cost: null,
    min_total_cost: null,
    partial_fill_step: '1',
    referral_code: ''
  })
};

fetch('https://api.derive.xyz/v3/private/send_rfq', 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/send_rfq",
  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' => '<unknown>',
    'subaccount_id' => 1,
    'client' => '',
    'counterparties' => null,
    'extra_fee' => '0',
    'label' => '',
    'max_total_cost' => null,
    'min_total_cost' => null,
    'partial_fill_step' => '1',
    'referral_code' => ''
  ]),
  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/send_rfq"

	payload := strings.NewReader("{\n  \"legs\": \"<unknown>\",\n  \"subaccount_id\": 1,\n  \"client\": \"\",\n  \"counterparties\": null,\n  \"extra_fee\": \"0\",\n  \"label\": \"\",\n  \"max_total_cost\": null,\n  \"min_total_cost\": null,\n  \"partial_fill_step\": \"1\",\n  \"referral_code\": \"\"\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/send_rfq")
  .header("Content-Type", "application/json")
  .body("{\n  \"legs\": \"<unknown>\",\n  \"subaccount_id\": 1,\n  \"client\": \"\",\n  \"counterparties\": null,\n  \"extra_fee\": \"0\",\n  \"label\": \"\",\n  \"max_total_cost\": null,\n  \"min_total_cost\": null,\n  \"partial_fill_step\": \"1\",\n  \"referral_code\": \"\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"legs\": \"<unknown>\",\n  \"subaccount_id\": 1,\n  \"client\": \"\",\n  \"counterparties\": null,\n  \"extra_fee\": \"0\",\n  \"label\": \"\",\n  \"max_total_cost\": null,\n  \"min_total_cost\": null,\n  \"partial_fill_step\": \"1\",\n  \"referral_code\": \"\"\n}"

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

{
  "ask_total_cost": "<string>",
  "bid_total_cost": "<string>",
  "creation_timestamp": 123,
  "filled_pct": "<string>",
  "label": "<string>",
  "last_update_timestamp": 123,
  "legs": [
    {
      "amount": "<string>",
      "instrument_name": "<string>"
    }
  ],
  "mark_total_cost": "<string>",
  "max_total_cost": "<string>",
  "min_total_cost": "<string>",
  "partial_fill_step": "<string>",
  "rfq_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subaccount_id": 123,
  "total_cost": "<string>",
  "valid_until": 123,
  "wallet": "<string>",
  "counterparties": [
    "<string>"
  ]
}

Body

application/json

legs

any

required

subaccount_id

integer<uint64>

required

Required range: x >= 0

client

string

default:""

counterparties

string[] | null

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

label

string

default:""

max_total_cost

string<decimal> | null

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

min_total_cost

string<decimal> | null

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

partial_fill_step

string<decimal>

default:1

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

referral_code

string

default:""

Response

Success

ask_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

bid_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

cancel_reason

enum<string>

required

Available options:

user_request,

insufficient_margin,

signed_max_fee_too_low,

mmp_trigger,

cancel_on_disconnect,

session_key_deregistered,

subaccount_withdrawn,

rfq_no_longer_open,

compliance

creation_timestamp

integer<int64>

required

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

label

string

required

last_update_timestamp

integer<int64>

required

legs

object[]

required

Show child attributes

mark_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

max_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

min_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

partial_fill_step

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

rfq_id

string<uuid>

required

UUID v4 string

status

enum<string>

required

Available options:

open,

filled,

cancelled,

expired

subaccount_id

integer<int64>

required

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

valid_until

integer<int64>

required

wallet

string

required

20-byte Ethereum address as a 0x-prefixed lowercase hex string.

Required string length: 42

Pattern: ^0x[0-9a-fA-F]{40}$

counterparties

string[] | null

20-byte Ethereum address as a 0x-prefixed lowercase hex string.

Required string length: 42

Pattern: ^0x[0-9a-fA-F]{40}$

filled_direction

enum<string> | null

Available options:

buy,

sell

Submit a maker quote for an RFQ

Preview EIP-712 signing data for a quote execution

⌘I

Create a request for quote (RFQ)

curl --request POST \
  --url https://api.derive.xyz/v3/private/send_rfq \
  --header 'Content-Type: application/json' \
  --data '
{
  "legs": "<unknown>",
  "subaccount_id": 1,
  "client": "",
  "counterparties": null,
  "extra_fee": "0",
  "label": "",
  "max_total_cost": null,
  "min_total_cost": null,
  "partial_fill_step": "1",
  "referral_code": ""
}
'

import requests

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

payload = {
    "legs": "<unknown>",
    "subaccount_id": 1,
    "client": "",
    "counterparties": None,
    "extra_fee": "0",
    "label": "",
    "max_total_cost": None,
    "min_total_cost": None,
    "partial_fill_step": "1",
    "referral_code": ""
}
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({
    legs: '<unknown>',
    subaccount_id: 1,
    client: '',
    counterparties: null,
    extra_fee: '0',
    label: '',
    max_total_cost: null,
    min_total_cost: null,
    partial_fill_step: '1',
    referral_code: ''
  })
};

fetch('https://api.derive.xyz/v3/private/send_rfq', 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/send_rfq",
  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' => '<unknown>',
    'subaccount_id' => 1,
    'client' => '',
    'counterparties' => null,
    'extra_fee' => '0',
    'label' => '',
    'max_total_cost' => null,
    'min_total_cost' => null,
    'partial_fill_step' => '1',
    'referral_code' => ''
  ]),
  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/send_rfq"

	payload := strings.NewReader("{\n  \"legs\": \"<unknown>\",\n  \"subaccount_id\": 1,\n  \"client\": \"\",\n  \"counterparties\": null,\n  \"extra_fee\": \"0\",\n  \"label\": \"\",\n  \"max_total_cost\": null,\n  \"min_total_cost\": null,\n  \"partial_fill_step\": \"1\",\n  \"referral_code\": \"\"\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/send_rfq")
  .header("Content-Type", "application/json")
  .body("{\n  \"legs\": \"<unknown>\",\n  \"subaccount_id\": 1,\n  \"client\": \"\",\n  \"counterparties\": null,\n  \"extra_fee\": \"0\",\n  \"label\": \"\",\n  \"max_total_cost\": null,\n  \"min_total_cost\": null,\n  \"partial_fill_step\": \"1\",\n  \"referral_code\": \"\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"legs\": \"<unknown>\",\n  \"subaccount_id\": 1,\n  \"client\": \"\",\n  \"counterparties\": null,\n  \"extra_fee\": \"0\",\n  \"label\": \"\",\n  \"max_total_cost\": null,\n  \"min_total_cost\": null,\n  \"partial_fill_step\": \"1\",\n  \"referral_code\": \"\"\n}"

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

{
  "ask_total_cost": "<string>",
  "bid_total_cost": "<string>",
  "creation_timestamp": 123,
  "filled_pct": "<string>",
  "label": "<string>",
  "last_update_timestamp": 123,
  "legs": [
    {
      "amount": "<string>",
      "instrument_name": "<string>"
    }
  ],
  "mark_total_cost": "<string>",
  "max_total_cost": "<string>",
  "min_total_cost": "<string>",
  "partial_fill_step": "<string>",
  "rfq_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subaccount_id": 123,
  "total_cost": "<string>",
  "valid_until": 123,
  "wallet": "<string>",
  "counterparties": [
    "<string>"
  ]
}

HTTP & WS Methods

WS-only Methods

WS Subscriptions

Create a request for quote (RFQ)

Body

Response