Claim insurance fund
curl --request POST \
--url https://api.orderly.org/v1/claim_insurance_fund \
--header 'Content-Type: application/json' \
--header 'orderly-account-id: <orderly-account-id>' \
--header 'orderly-key: <orderly-key>' \
--header 'orderly-signature: <orderly-signature>' \
--header 'orderly-timestamp: <orderly-timestamp>' \
--data '
{
"claim_id": 123,
"symbol": "<string>",
"qty_request": 123
}
'import requests
url = "https://api.orderly.org/v1/claim_insurance_fund"
payload = {
"claim_id": 123,
"symbol": "<string>",
"qty_request": 123
}
headers = {
"orderly-timestamp": "<orderly-timestamp>",
"orderly-account-id": "<orderly-account-id>",
"orderly-key": "<orderly-key>",
"orderly-signature": "<orderly-signature>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'orderly-timestamp': '<orderly-timestamp>',
'orderly-account-id': '<orderly-account-id>',
'orderly-key': '<orderly-key>',
'orderly-signature': '<orderly-signature>',
'Content-Type': 'application/json'
},
body: JSON.stringify({claim_id: 123, symbol: '<string>', qty_request: 123})
};
fetch('https://api.orderly.org/v1/claim_insurance_fund', 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.orderly.org/v1/claim_insurance_fund",
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([
'claim_id' => 123,
'symbol' => '<string>',
'qty_request' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"orderly-account-id: <orderly-account-id>",
"orderly-key: <orderly-key>",
"orderly-signature: <orderly-signature>",
"orderly-timestamp: <orderly-timestamp>"
],
]);
$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.orderly.org/v1/claim_insurance_fund"
payload := strings.NewReader("{\n \"claim_id\": 123,\n \"symbol\": \"<string>\",\n \"qty_request\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("orderly-timestamp", "<orderly-timestamp>")
req.Header.Add("orderly-account-id", "<orderly-account-id>")
req.Header.Add("orderly-key", "<orderly-key>")
req.Header.Add("orderly-signature", "<orderly-signature>")
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.orderly.org/v1/claim_insurance_fund")
.header("orderly-timestamp", "<orderly-timestamp>")
.header("orderly-account-id", "<orderly-account-id>")
.header("orderly-key", "<orderly-key>")
.header("orderly-signature", "<orderly-signature>")
.header("Content-Type", "application/json")
.body("{\n \"claim_id\": 123,\n \"symbol\": \"<string>\",\n \"qty_request\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orderly.org/v1/claim_insurance_fund")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["orderly-timestamp"] = '<orderly-timestamp>'
request["orderly-account-id"] = '<orderly-account-id>'
request["orderly-key"] = '<orderly-key>'
request["orderly-signature"] = '<orderly-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"claim_id\": 123,\n \"symbol\": \"<string>\",\n \"qty_request\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"liquidation_id": 101,
"timestamp": 1663313562090,
"positions_by_perp": [
{
"symbol": "PERP_BTC_USDC",
"abs_liquidator_fee": 1.152279,
"cost_position_transfer": 21.002786,
"liquidator_fee": 0.006,
"position_qty": 0.00017,
"transfer_price": 123545.8
}
]
},
"timestamp": 1702989203989
}Liquidations
Claim insurance fund
Limit: 5 requests per 1 second
POST /v1/claim_insurance_fund
POST
/
v1
/
claim_insurance_fund
Claim insurance fund
curl --request POST \
--url https://api.orderly.org/v1/claim_insurance_fund \
--header 'Content-Type: application/json' \
--header 'orderly-account-id: <orderly-account-id>' \
--header 'orderly-key: <orderly-key>' \
--header 'orderly-signature: <orderly-signature>' \
--header 'orderly-timestamp: <orderly-timestamp>' \
--data '
{
"claim_id": 123,
"symbol": "<string>",
"qty_request": 123
}
'import requests
url = "https://api.orderly.org/v1/claim_insurance_fund"
payload = {
"claim_id": 123,
"symbol": "<string>",
"qty_request": 123
}
headers = {
"orderly-timestamp": "<orderly-timestamp>",
"orderly-account-id": "<orderly-account-id>",
"orderly-key": "<orderly-key>",
"orderly-signature": "<orderly-signature>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'orderly-timestamp': '<orderly-timestamp>',
'orderly-account-id': '<orderly-account-id>',
'orderly-key': '<orderly-key>',
'orderly-signature': '<orderly-signature>',
'Content-Type': 'application/json'
},
body: JSON.stringify({claim_id: 123, symbol: '<string>', qty_request: 123})
};
fetch('https://api.orderly.org/v1/claim_insurance_fund', 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.orderly.org/v1/claim_insurance_fund",
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([
'claim_id' => 123,
'symbol' => '<string>',
'qty_request' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"orderly-account-id: <orderly-account-id>",
"orderly-key: <orderly-key>",
"orderly-signature: <orderly-signature>",
"orderly-timestamp: <orderly-timestamp>"
],
]);
$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.orderly.org/v1/claim_insurance_fund"
payload := strings.NewReader("{\n \"claim_id\": 123,\n \"symbol\": \"<string>\",\n \"qty_request\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("orderly-timestamp", "<orderly-timestamp>")
req.Header.Add("orderly-account-id", "<orderly-account-id>")
req.Header.Add("orderly-key", "<orderly-key>")
req.Header.Add("orderly-signature", "<orderly-signature>")
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.orderly.org/v1/claim_insurance_fund")
.header("orderly-timestamp", "<orderly-timestamp>")
.header("orderly-account-id", "<orderly-account-id>")
.header("orderly-key", "<orderly-key>")
.header("orderly-signature", "<orderly-signature>")
.header("Content-Type", "application/json")
.body("{\n \"claim_id\": 123,\n \"symbol\": \"<string>\",\n \"qty_request\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orderly.org/v1/claim_insurance_fund")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["orderly-timestamp"] = '<orderly-timestamp>'
request["orderly-account-id"] = '<orderly-account-id>'
request["orderly-key"] = '<orderly-key>'
request["orderly-signature"] = '<orderly-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"claim_id\": 123,\n \"symbol\": \"<string>\",\n \"qty_request\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"liquidation_id": 101,
"timestamp": 1663313562090,
"positions_by_perp": [
{
"symbol": "PERP_BTC_USDC",
"abs_liquidator_fee": 1.152279,
"cost_position_transfer": 21.002786,
"liquidator_fee": 0.006,
"position_qty": 0.00017,
"transfer_price": 123545.8
}
]
},
"timestamp": 1702989203989
}Headers
Timestamp of the signed request in milliseconds.
Account ID of the authenticated account.
Public orderly key used to sign the request.
Signature of the request payload generated with the orderly key.
Body
application/json
Quantity to be claimed from insurance fund
Liquidator’s instruction to let the system reject the liquidation claim if the following condition applies: if position_qty > 0, reject if mark_price > limit_price; if position_qty < 0, reject if mark_price < limit_price
Show child attributes
Show child attributes
⌘I