Skip to main content
Subscription Request
type:object

Client sends subscription request to subscribe to notification channel. Please refer to Notification page for more information.

Subscription Notification Data
type:object

Server sends subscription notification data

data
type:object
required
state
type:enum
required

The stage of the liquidation/ADL/LSP process this notification represents:

  • liquidation_started / liquidation_completed: The standard (order-book) liquidation process has started or completed for this account.
  • close_out_liquidation_started / close_out_liquidation_completed: The LSP/ADL close-out process has started or completed for this account. An account can go through this pair, the liquidation_started/liquidation_completed pair, or both in sequence (e.g. LSP/ADL close-out first, handed off to standard liquidation if it can't fully resolve the breach).
  • lsp_transfer: A position was transferred off this account to an LSP participant. Sent to the liquidated (source) account — see the user.lsp channel for the notification sent to the receiving participant.
  • adl_transfer: A position was auto-deleveraged off this account. Sent to the account being deleveraged (source).
  • adl_transfer_received: A position was auto-deleveraged onto this account from a counterparty. Sent to the receiving (counterparty) account.
Available options: liquidation_started, liquidation_completed, close_out_liquidation_started, close_out_liquidation_completed, lsp_transfer, adl_transfer, adl_transfer_received
user_id
type:integer
required

Unique user identifier

isolated
type:boolean

Present and true only when this event applies to an isolated-margin subaccount.

currency
type:enum

Currency, i.e "BTC", "ETH", "USDC"

Available options: BTC, ETH, USDC, USDT, EURR
margin_balance
type:number

Present for liquidation_started, liquidation_completed, close_out_liquidation_started, and close_out_liquidation_completed.

maintenance_margin
type:number

Present for liquidation_started, liquidation_completed, close_out_liquidation_started, and close_out_liquidation_completed.

initial_margin
type:number

Present for liquidation_started, liquidation_completed, close_out_liquidation_started, and close_out_liquidation_completed.

close_out_margin
type:number

Present for liquidation_started, liquidation_completed, close_out_liquidation_started, and close_out_liquidation_completed.

equity
type:number

Present for liquidation_started, liquidation_completed, close_out_liquidation_started, and close_out_liquidation_completed.

instrument_name
type:string

Unique instrument identifier

direction
type:enum

Present for lsp_transfer, adl_transfer, and adl_transfer_received. This account's own resulting position side.

Available options: buy, sell
amount
type:number

Present for lsp_transfer, adl_transfer, and adl_transfer_received.

price
type:number

Present for lsp_transfer, adl_transfer, and adl_transfer_received. The transfer price applied.

commission
type:number

Present for lsp_transfer, adl_transfer, and adl_transfer_received. The commission charged (on lsp_transfer/adl_transfer) or this account's share of the commission (on adl_transfer_received; 0 for an intra-account subaccount ADL move).

timestamp
type:integer
required

The timestamp (milliseconds since the Unix epoch)