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,
  "symbols": {
    "ratio_qty_request": 123,
    "symbol": "<string>"
  }
}
'
{
  "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