public/get_instrument
Returns the full public definition of one instrument named by instrument_name: type, activation window and active status, tick size, min/max/step amounts, maker/taker/base fee rates, pro-rata matching parameters, base/quote currencies, and type-specific details (option, perp, or spot). Expired options remain queryable by instrument_name. Public endpoint.
curl --request POST \
--url https://api.derive.xyz/v3/public/get_instrument \
--header 'Content-Type: application/json' \
--data '
{
"instrument_name": "<string>"
}
'import requests
url = "https://api.derive.xyz/v3/public/get_instrument"
payload = { "instrument_name": "<string>" }
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({instrument_name: '<string>'})
};
fetch('https://api.derive.xyz/v3/public/get_instrument', 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/public/get_instrument",
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([
'instrument_name' => '<string>'
]),
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/public/get_instrument"
payload := strings.NewReader("{\n \"instrument_name\": \"<string>\"\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/public/get_instrument")
.header("Content-Type", "application/json")
.body("{\n \"instrument_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/public/get_instrument")
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 \"instrument_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"amount_step": "<string>",
"base_asset_address": "<string>",
"base_asset_sub_id": "<string>",
"base_currency": "<string>",
"base_fee": "<string>",
"fifo_min_allocation": "<string>",
"instrument_name": "<string>",
"instrument_type": "option",
"is_active": true,
"maker_fee_rate": "<string>",
"maximum_amount": "<string>",
"minimum_amount": "<string>",
"pro_rata_amount_step": "<string>",
"pro_rata_fraction": "<string>",
"quote_currency": "<string>",
"risk_universe_id": 1,
"scheduled_activation": 123,
"scheduled_deactivation": 123,
"taker_fee_rate": "<string>",
"tick_size": "<string>",
"erc20_details": {
"borrow_index": "<string>",
"decimals": 1,
"supply_index": "<string>",
"underlying_erc20_address": "<string>"
},
"mark_price_fee_rate_cap": "<string>",
"option_details": {
"expiry": 1,
"index": "<string>",
"option_type": "<string>",
"strike": "<string>",
"settlement_price": "<string>"
},
"perp_details": {
"aggregate_funding": "<string>",
"funding_rate": "<string>",
"index": "<string>",
"max_rate_per_hour": "<string>",
"min_rate_per_hour": "<string>",
"srm_perp_margin_requirements": {
"im_perp_req": "<string>",
"max_leverage": "<string>",
"mm_perp_req": "<string>"
}
}
}{
"error": {
"code": 123,
"message": "<string>",
"data": "<string>"
}
}Body
Response
Success
The traded asset's contract address — word 0 (asset) of the order action data. Use this (not erc20_details) when signing an order.
The traded asset's sub-id — word 1 (subId) of the order action data. Decimal string; "0" for perps and spot.
Asset type of the instrument: "option", "perp", or "erc20".
option, perp, erc20 Only subaccounts in this risk universe can trade the instrument.
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
curl --request POST \
--url https://api.derive.xyz/v3/public/get_instrument \
--header 'Content-Type: application/json' \
--data '
{
"instrument_name": "<string>"
}
'import requests
url = "https://api.derive.xyz/v3/public/get_instrument"
payload = { "instrument_name": "<string>" }
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({instrument_name: '<string>'})
};
fetch('https://api.derive.xyz/v3/public/get_instrument', 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/public/get_instrument",
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([
'instrument_name' => '<string>'
]),
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/public/get_instrument"
payload := strings.NewReader("{\n \"instrument_name\": \"<string>\"\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/public/get_instrument")
.header("Content-Type", "application/json")
.body("{\n \"instrument_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/public/get_instrument")
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 \"instrument_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"amount_step": "<string>",
"base_asset_address": "<string>",
"base_asset_sub_id": "<string>",
"base_currency": "<string>",
"base_fee": "<string>",
"fifo_min_allocation": "<string>",
"instrument_name": "<string>",
"instrument_type": "option",
"is_active": true,
"maker_fee_rate": "<string>",
"maximum_amount": "<string>",
"minimum_amount": "<string>",
"pro_rata_amount_step": "<string>",
"pro_rata_fraction": "<string>",
"quote_currency": "<string>",
"risk_universe_id": 1,
"scheduled_activation": 123,
"scheduled_deactivation": 123,
"taker_fee_rate": "<string>",
"tick_size": "<string>",
"erc20_details": {
"borrow_index": "<string>",
"decimals": 1,
"supply_index": "<string>",
"underlying_erc20_address": "<string>"
},
"mark_price_fee_rate_cap": "<string>",
"option_details": {
"expiry": 1,
"index": "<string>",
"option_type": "<string>",
"strike": "<string>",
"settlement_price": "<string>"
},
"perp_details": {
"aggregate_funding": "<string>",
"funding_rate": "<string>",
"index": "<string>",
"max_rate_per_hour": "<string>",
"min_rate_per_hour": "<string>",
"srm_perp_margin_requirements": {
"im_perp_req": "<string>",
"max_leverage": "<string>",
"mm_perp_req": "<string>"
}
}
}{
"error": {
"code": 123,
"message": "<string>",
"data": "<string>"
}
}