Skip to main content
POST
/
v1
/
liquidation
Claim liquidated positions
curl --request POST \
  --url https://api.orderly.org/v1/liquidation \
  --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 '
{
  "liquidation_id": 123,
  "ratio_qty_request": 123,
  "limit_price": {
    "symbol": 123
  },
  "extra_liquidation_ratio": 123
}
'
import requests

url = "https://api.orderly.org/v1/liquidation"

payload = {
"liquidation_id": 123,
"ratio_qty_request": 123,
"limit_price": { "symbol": 123 },
"extra_liquidation_ratio": 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({
liquidation_id: 123,
ratio_qty_request: 123,
limit_price: {symbol: 123},
extra_liquidation_ratio: 123
})
};

fetch('https://api.orderly.org/v1/liquidation', 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/liquidation",
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([
'liquidation_id' => 123,
'ratio_qty_request' => 123,
'limit_price' => [
'symbol' => 123
],
'extra_liquidation_ratio' => 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/liquidation"

payload := strings.NewReader("{\n \"liquidation_id\": 123,\n \"ratio_qty_request\": 123,\n \"limit_price\": {\n \"symbol\": 123\n },\n \"extra_liquidation_ratio\": 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/liquidation")
.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 \"liquidation_id\": 123,\n \"ratio_qty_request\": 123,\n \"limit_price\": {\n \"symbol\": 123\n },\n \"extra_liquidation_ratio\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.orderly.org/v1/liquidation")

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 \"liquidation_id\": 123,\n \"ratio_qty_request\": 123,\n \"limit_price\": {\n \"symbol\": 123\n },\n \"extra_liquidation_ratio\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "liquidation_id": 123,
    "timestamp": 123,
    "type": "<string>",
    "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

orderly-timestamp
string
required

Timestamp of the signed request in milliseconds.

orderly-account-id
string
required

Account ID of the authenticated account.

orderly-key
string
required

Public orderly key used to sign the request.

orderly-signature
string
required

Signature of the request payload generated with the orderly key.

Body

application/json
liquidation_id
integer
required
ratio_qty_request
integer
required
limit_price
object
required

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

extra_liquidation_ratio
integer
symbols
object

For high risk tiers only

Response

200 - application/json

OK

success
boolean
required

Indicates whether the request was successful.

Example:

true

data
object
required
timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989