Get Liquidated Positions of Account

#Endpoint

GET /v1/liquidations

Mainnet: https://api.orderly.org/v1/liquidations

Testnet: https://testnet-api.orderly.org/v1/liquidations

Rate limit: 10 requests per second per IP address.

Returns liquidation records for the authenticated account.

#Authentication

Send the signed-request headers.

• orderly-timestamp — required; signed-request timestamp in milliseconds.
• orderly-account-id — required; authenticated account ID.
• orderly-key — required; public API key.
• orderly-signature — required; signature generated for the request.

#Query parameters

• symbol (string, optional) — market filter.
• start_t, end_t (numbers, optional) — time-range filters.
• page (number, optional) — page number, starting at 1.
• size (number, optional) — number of records per page.
• sort_by (string, optional) — sort by liquidation_id or time.
• liquidation_id (number, optional) — return the specified liquidation ID only.

#Response

HTTP 200 — application/json. success (required boolean), data (required object), and a server timestamp (integer milliseconds) form the response. data.meta contains required integer values total, records_per_page, and current_page.

Each item in the required data.rows array may include liquidation_id, timestamp, transfer_amount_to_insurance_fund, margin_ratio, account_mmr, position_notional, and collateral_value (numbers), plus a required positions_by_perp array.

Each position requires total_position (number), symbol (string), position_qty, liquidator_fee, cost_position_transfer, transfer_price, insurance_fund_fee, abs_insurance_fund_fee, and abs_liquidation_fee (numbers). abs_insurance_fund_fee is the absolute amount allocated to the insurance fund. abs_liquidation_fee is the total absolute liquidation fee: liquidator fee plus insurance-fund fee. mark_price (number) is optional.

{
  "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,
        "abs_liquidation_fee": 0.252034,
        "mark_price": 123400
      }]
    }]
  },
  "timestamp": 1702989203989
}