Skip to main content
WEBHOOK

Body

application/json

US perpetuals margin state reported for a user. All amounts are in USD, the quote currency of US perpetuals. Each update carries the complete state and replaces the previously received one.

type
string
required

Webhook event identifier.

Allowed value: "derivatives.margin_updated"
user_id
string
required

Globally unique public identifier for a user.

Required string length: 14 - 42
account_id
string
required

Globally unique public identifier for an account.

Required string length: 14 - 42
cash_balance_in_quote
string
required

Cash balance available for US perpetuals.

pnl
object
required

Profit and loss across open positions.

margin
object
required

Margin requirements and withheld margin.

distance_to_liquidation_in_quote
string
required

Distance to automatic liquidation.

updated_at
string<date-time>
required

Time the margin state was published.

Response

2XX

Delivery endpoint accepted the webhook.