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>'
{
  "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