Skip to main content
GET
/
v1
/
liquidations
Get liquidated positions of account
curl --request GET \
  --url https://api.orderly.org/v1/liquidations \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'
import requests

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

headers = {
"orderly-timestamp": "<orderly-timestamp>",
"orderly-account-id": "<orderly-account-id>",
"orderly-key": "<orderly-key>",
"orderly-signature": "<orderly-signature>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {
'orderly-timestamp': '<orderly-timestamp>',
'orderly-account-id': '<orderly-account-id>',
'orderly-key': '<orderly-key>',
'orderly-signature': '<orderly-signature>'
}
};

fetch('https://api.orderly.org/v1/liquidations', 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/liquidations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)

func main() {

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

req, _ := http.NewRequest("GET", url, nil)

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>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.orderly.org/v1/liquidations")
.header("orderly-timestamp", "<orderly-timestamp>")
.header("orderly-account-id", "<orderly-account-id>")
.header("orderly-key", "<orderly-key>")
.header("orderly-signature", "<orderly-signature>")
.asString();
require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["orderly-timestamp"] = '<orderly-timestamp>'
request["orderly-account-id"] = '<orderly-account-id>'
request["orderly-key"] = '<orderly-key>'
request["orderly-signature"] = '<orderly-signature>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "meta": {
      "total": 9,
      "records_per_page": 25,
      "current_page": 1
    },
    "rows": [
      {
        "liquidation_id": 101,
        "timestamp": 1663313562090,
        "transfer_amount_to_insurance_fund": 0,
        "margin_ratio": 0.10436069,
        "account_mmr": 0.012,
        "position_notional": 28.415534,
        "collateral_value": 2.965465,
        "positions_by_perp": [
          {
            "total_position": 41.6,
            "symbol": "PERP_BTC_USDC",
            "position_qty": 0.00017,
            "liquidator_fee": 0.006,
            "cost_position_transfer": 21.002786,
            "transfer_price": 123545.8,
            "insurance_fund_fee": 0.006,
            "abs_insurance_fund_fee": 0.126017,
            "mark_price": 123400,
            "abs_liquidator_fee": 0.252034
          }
        ]
      }
    ]
  },
  "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.

Query Parameters

symbol
string
start_t
number
end_t
number
page
number

start from 1

size
number
sort_by
string

liquidation_id/time

liquidation_id
number

return the designed liquidation_id 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