v1

latestOpenAPI 3.0.32026-07-267278168.1 KB

Margin Account

Get Liquidation History

Returns a paginated history of liquidation events for the authenticated account. For how liquidations work, see Liquidations.

get/v1/perps/liquidation_history

Query parameters

marketstring

Example:AAPL-USD.P

Filter by market

limitinteger

Example:100

Maximum number of results to return

cursorstring

Example:NQ5WWO3THN3Q====

Pagination cursor

startTimeinteger

Example:1684814400000

Start time filter (UTC milliseconds)

endTimeinteger

Example:1672549200000

End time filter (UTC milliseconds)

Response

Paginated list of liquidation events

successboolean required

Whether the request was successful

errorstring

Error message, present only on failure

error_codestring

Semantic error code. See each endpoint's error responses for the specific codes it can return.

deprecatedstring

Deprecation notice, if applicable

Example response

{
  "success": true,
  "result": [
    {
      "id": "liq_70a37d8f972f2494837f9dba8364cbb4",
      "time": "2024-01-04T16:13:34Z",
      "initiatedAt": "2024-01-04T16:13:30Z",
      "accountId": "10458932786832481",
      "status": "start",
      "insuranceFundUsed": "0.00",
      "triggeringPositions": [
        {
          "market": "AAPL-USD.P",
          "direction": "short",
          "netQuantity": "1.5489",
          "averageEntryPrice": "20566.84",
          "usedMargin": "2566.84",
          "unrealizedPnl": "-900.54",
          "markPrice": "20000.54",
          "liquidationPrice": "9000.87",
          "bankruptcyPrice": "6000.11",
          "maintenanceMargin": "1500.22",
          "notionalValue": "30000.00",
          "leverage": "10.0",
          "netFundingSinceNeutral": "-12.34",
          "returnOnEquity": "-0.35",
          "stopLossTriggerPrice": "18000.00",
          "takeProfitTriggerPrice": "25000.00"
        }
      ],
      "filledQuoteSize": "5000.00",
      "filledQuantity": "0.25"
    }
  ],
  "pageInfo": {
    "prevCursor": "O4ZTGM3RGM2DG===",
    "nextCursor": "NQ5WWO3THN3Q===="
  }
}