Claim Liquidated Positions

#Endpoint

POST /v1/liquidation

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

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

Rate limit: 5 requests per second.

#Authentication

Send the signed-request headers with an application/json body.

• 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.

#Request body

• liquidation_id (integer, required).
• ratio_qty_request (integer, required).
• limit_price (object, required) — provides a limit price for each symbol in the claim. When position_qty is positive, the claim is rejected if mark_price is above its limit. When position_qty is negative, it is rejected if mark_price is below its limit. The nested limit_price.symbol value is a required number.
• extra_liquidation_ratio (integer, optional).
• symbols (object, optional) — for high-risk tier liquidations only. Each entry includes ratio_qty_request (number, required) to set the requested liquidation ratio for that symbol and symbol (string, required). This applies to symbols with liquidation tier 2.

#Response

HTTP 200 — application/json. success is a required boolean. data is a required object containing liquidation_id (integer, required), timestamp (number, required), type (string, required; the claim value is claim), and positions_by_perp (required array).

Each returned position can include symbol (string), abs_liquidator_fee, cost_position_transfer, liquidator_fee, position_qty, and transfer_price (numbers).

The response-root timestamp is the server time in milliseconds (integer).