Skip to main content
Refer to Websocket for establishing the websocket connection. This channel requires the account’s API key. Open the connection with the PF-API-KEY header set to a key that belongs to the subscribed account, as described in API Config Keys. Any other subscribe fails with code 403. There is no exchange-wide liquidation channel.

Params

Stream

The channel sends no snapshot on subscribe. It sends each event once, as it happens.
FieldTypeDescription
’u’stringAccount address
’s’stringSymbol
’m’stringHow the position closed. See below
’d’stringSide of the closed position: ‘bid’ - long, ‘ask’ - short
’a’decimal stringClosed amount
’p’decimal stringAverage fill price for ‘market’, otherwise the transfer or ADL price
’i’integerLiquidation order ID for ‘market’, otherwise null
’t’numberTimestamp in milliseconds
’li’numberLast ID — sequence number of the operation

Mechanism ('m')

Every value except 'adl' means the account was liquidated. 'adl' names the profitable side that ADL closed. A chunked market liquidation sends one event for each chunk that fills. The trades that the close produced arrive on Account Trades with the same li. Join them on (li, u, s). The channel does not report delisting closes or the backstop liquidator’s side of a transfer.