Messages

{
  "data": {
    "type": "transfer",
    "instrument_name": "BTC-PERPETUAL",
    "direction": "sell",
    "amount": 5000,
    "price": 63481.75,
    "currency": "BTC",
    "success": true,
    "timestamp": 1750000400000
  }
}

User

user.lsp

Notifications for an LSP (Liquidity Support Program) participant subaccount: assignment attempts (successful or failed), enable/disable state changes, and effective configuration changes.

Subscribe to this channel with an API key belonging to the LSP participant subaccount itself. See user.liquidation for the notification sent to the liquidated (source) user whose position was transferred.

Every notification includes a type field identifying the event kind — see the notification schema for the full list of types and which fields accompany each.

Messages

{
  "data": {
    "type": "transfer",
    "instrument_name": "BTC-PERPETUAL",
    "direction": "sell",
    "amount": 5000,
    "price": 63481.75,
    "currency": "BTC",
    "success": true,
    "timestamp": 1750000400000
  }
}

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

type

type:enum

required

The kind of LSP (Liquidity Support Program) event this notification represents:

transfer: An assignment attempt to this participant completed — check success to see whether it succeeded (fully or partially) or failed and was redistributed to other participants (or fell through to ADL).
enabled: This participant's LSP configuration transitioned from disabled to enabled.
disabled: This participant's LSP configuration transitioned from enabled to disabled — check automatic to see whether this was a manual change or an automatic disable after repeated transfer failures.
configuration_changed: This participant's effective configuration changed (enable state and/or any group limit, including a change to the platform-wide default that affects this participant). Fired on every configuration write, including no-op enable/disable transitions.

Available options: transfer, enabled, disabled, configuration_changed

instrument_name

type:string

Unique instrument identifier

direction

type:enum

Present for transfer only.

Available options: buy, sell

amount

type:number

Present for transfer only. Size of the position assigned (or attempted).

price

type:number

Present for transfer only. The transfer price applied to this assignment attempt.

currency

type:enum

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

Available options: BTC, ETH, USDC, USDT, EURR

success

type:boolean

Present for transfer only. true if the assignment succeeded, false if it failed (see error_reason).

error_reason

type:enum

Present for transfer only, and only when success is false. Machine-readable failure reason.

Available options: platform_locked, lock_count_exceeded, timeout, temporarily_unavailable, not_enough_funds, internal_error

automatic

type:boolean

Present for disabled only. true if this was an automatic disable after repeated transfer failures, false if a manual configuration change.

failure_count

type:integer

Present for disabled only, and only when automatic is true. Number of transfer failures that triggered the auto-disable.

window_minutes

type:integer

Present for disabled only, and only when automatic is true. Length of the failure-counting window, in minutes.

configuration

type:object

Present for configuration_changed only. The participant's resolved effective configuration: enabled, plus every cooldown group's effective limit percentage (group_limits, keyed by group) — per-participant overrides are already resolved against the platform-wide defaults, so every group appears here regardless of whether this participant has an explicit override.

timestamp

type:integer

required

The timestamp (milliseconds since the Unix epoch)

user.isolated.liquidation block_rfq.maker.(currency)

⌘I

Introduction

Websockets

user.lsp