Messages

{
  "data": {
    "delta_total_map": {
      "btc_usd": 31.594397699
    },
    "margin_balance": 302.62675921,
    "futures_session_rpl": -0.03311399,
    "options_session_rpl": 0,
    "estimated_liquidation_ratio_map": {
      "btc_usd": 0.10098729140701267
    },
    "session_upl": 0.05341555,
    "estimated_liquidation_ratio": 0.10098729,
    "options_gamma_map": {
      "btc_usd": 0.00001
    },
    "options_vega": 0.07976,
    "options_value": -0.0079,
    "available_withdrawal_funds": 301.35426172,
    "projected_delta_total": 32.613978,
    "maintenance_margin": 0.8854841,
    "total_pl": -0.33014225,
    "options_theta_map": {
      "btc_usd": 16.13825
    },
    "projected_maintenance_margin": 0.7543841,
    "available_funds": 301.38036328,
    "options_delta": -1.01958,
    "balance": 302.60065765,
    "equity": 302.6188592,
    "futures_session_upl": 0.05921555,
    "fee_balance": 0,
    "currency": "BTC",
    "options_session_upl": -0.0058,
    "projected_initial_margin": 1.01529592,
    "options_theta": 16.13825,
    "portfolio_margining_enabled": false,
    "cross_collateral_enabled": false,
    "margin_model": "segregated_sm",
    "options_vega_map": {
      "btc_usd": 0.07976
    },
    "futures_pl": -0.32434225,
    "options_pl": -0.0058,
    "initial_margin": 1.24639592,
    "spot_reserve": 0,
    "delta_total": 31.602298,
    "options_gamma": 0.00001,
    "session_rpl": -0.03311399,
    "additional_reserve": 0
  }
}

User

user.portfolio.(currency)

Real-time notifications for user portfolio information. This subscription provides comprehensive account and portfolio data for the specified currency, including balances, margins, profit and loss, and Greeks.

Each notification includes:

Account balances: Current balance, equity, margin balance, available funds, and available withdrawal funds
Margin information: Initial margin, maintenance margin, and projected margins
Profit and Loss: Total P&L, session unrealized P&L (UPL), session realized P&L (RPL), and separate P&L for options and futures
Options Greeks: Delta, gamma, theta, vega, and options value, with per-index mappings
Position data: Delta total, projected delta total, and delta total map per index
Account settings: Portfolio margining status, cross collateral status, and margin model
Cross collateral data: Total equity, margins, and delta in USD (when cross collateral is enabled)
Additional reserves: Fee balance and additional reserve information

When cross collateral is enabled, aggregated values are calculated by converting the sum of each cross collateral currency’s value to the given currency, using each cross collateral currency’s index.

Subscribe to a specific currency (BTC, ETH, USDC, USDT, etc.) or use any to receive portfolio updates for all currencies.

Messages

{
  "data": {
    "delta_total_map": {
      "btc_usd": 31.594397699
    },
    "margin_balance": 302.62675921,
    "futures_session_rpl": -0.03311399,
    "options_session_rpl": 0,
    "estimated_liquidation_ratio_map": {
      "btc_usd": 0.10098729140701267
    },
    "session_upl": 0.05341555,
    "estimated_liquidation_ratio": 0.10098729,
    "options_gamma_map": {
      "btc_usd": 0.00001
    },
    "options_vega": 0.07976,
    "options_value": -0.0079,
    "available_withdrawal_funds": 301.35426172,
    "projected_delta_total": 32.613978,
    "maintenance_margin": 0.8854841,
    "total_pl": -0.33014225,
    "options_theta_map": {
      "btc_usd": 16.13825
    },
    "projected_maintenance_margin": 0.7543841,
    "available_funds": 301.38036328,
    "options_delta": -1.01958,
    "balance": 302.60065765,
    "equity": 302.6188592,
    "futures_session_upl": 0.05921555,
    "fee_balance": 0,
    "currency": "BTC",
    "options_session_upl": -0.0058,
    "projected_initial_margin": 1.01529592,
    "options_theta": 16.13825,
    "portfolio_margining_enabled": false,
    "cross_collateral_enabled": false,
    "margin_model": "segregated_sm",
    "options_vega_map": {
      "btc_usd": 0.07976
    },
    "futures_pl": -0.32434225,
    "options_pl": -0.0058,
    "initial_margin": 1.24639592,
    "spot_reserve": 0,
    "delta_total": 31.602298,
    "options_gamma": 0.00001,
    "session_rpl": -0.03311399,
    "additional_reserve": 0
  }
}

currency

type:string

required

Currency code or any for all

Allowed values: BTC, ETH, USDC, USDT, EURR, any

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

user.mmp_trigger.(index_name) user.trades.(instrument_name).(interval)

⌘I

Introduction

Websockets

user.portfolio.(currency)