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.| Field | Type | Description |
|---|---|---|
’u’ | string | Account address |
’s’ | string | Symbol |
’m’ | string | How the position closed. See below |
’d’ | string | Side of the closed position: ‘bid’ - long, ‘ask’ - short |
’a’ | decimal string | Closed amount |
’p’ | decimal string | Average fill price for ‘market’, otherwise the transfer or ADL price |
’i’ | integer | Liquidation order ID for ‘market’, otherwise null |
’t’ | number | Timestamp in milliseconds |
’li’ | number | Last 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.