{
"jsonrpc": "2.0",
"method": "public/subscribe",
"id": 42,
"params": {
"channels": [
"user.portfolio.(currency)"
]
}
}{
"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.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.
{
"jsonrpc": "2.0",
"method": "public/subscribe",
"id": 42,
"params": {
"channels": [
"user.portfolio.(currency)"
]
}
}{
"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 code or any for all
Allowed values: BTC, ETH, USDC, USDT, EURR, any
BTC, ETH, USDC, USDT, EURR, anyClient sends subscription request to subscribe to notification channel. Please refer to Notification page for more information.
Server sends subscription notification data
The selected currency
The account's current equity
The maintenance margin. When cross collateral is enabled, this aggregated value is calculated by converting the sum of each cross collateral currency's value to the given currency, using each cross collateral currency's index.
The account's initial margin. When cross collateral is enabled, this aggregated value is calculated by converting the sum of each cross collateral currency's value to the given currency, using each cross collateral currency's index.
The account's available funds. When cross collateral is enabled, this aggregated value is calculated by converting the sum of each cross collateral currency's value to the given currency, using each cross collateral currency's index.
The account's available to withdrawal funds
The account's balance
The account's fee balance (it can be used to pay for fees)
The account's margin balance. When cross collateral is enabled, this aggregated value is calculated by converting the sum of each cross collateral currency's value to the given currency, using each cross collateral currency's index.
Session unrealized profit and loss
Session realized profit and loss
Profit and loss
Options profit and Loss
Options session realized profit and Loss
Options session unrealized profit and Loss
Options summary delta
Options summary gamma
Options summary theta
Options value
Options summary vega
Futures profit and Loss
Futures session realized profit and Loss
Futures session unrealized profit and Loss
The sum of position deltas.
DeltaTotal = Net Transaction Delta of options + BTC Position of Futures
The DeltaTotal uses the Net Transaction Delta (or price adjusted Delta) of the options, where Net Transaction Delta = Black Scholes Delta - Mark Price of Options.
This is because, from a risk perspective, we are interested in the change in Bitcoin price as the underlying changes.
You should actually treat your delta as Equity + Delta Total if you want to have less risk for your USD PnL.
⚠️ During the 30 minute settlement period we decay your Delta. See Delta decay during settlement for more details.
Map of position sum's per index
Map of options' gammas per index
Map of options' thetas per index
Map of options' vegas per index
The sum of position deltas without positions that will expire during closest expiration
When true portfolio margining is enabled for user
When true cross collateral is enabled for user
Name of user's currently enabled margin model
Optional (only for users using cross margin). The account's total equity in all cross collateral currencies, expressed in USD
Optional (only for users using cross margin). The account's total initial margin in all cross collateral currencies, expressed in USD
Optional (only for users using cross margin). The account's total maintenance margin in all cross collateral currencies, expressed in USD
Optional (only for users using cross margin). The account's total margin balance in all cross collateral currencies, expressed in USD
Optional (only for users using cross margin). The account's total delta total in all cross collateral currencies, expressed in USD
Projected initial margin. When cross collateral is enabled, this aggregated value is calculated by converting the sum of each cross collateral currency's value to the given currency, using each cross collateral currency's index.
Projected maintenance margin. When cross collateral is enabled, this aggregated value is calculated by converting the sum of each cross collateral currency's value to the given currency, using each cross collateral currency's index.
[DEPRECATED] Estimated Liquidation Ratio is returned only for users with segregated_sm margin model. Multiplying it by future position's market price returns its estimated liquidation price. Use estimated_liquidation_ratio_map instead.
Map of Estimated Liquidation Ratio per index, it is returned only for users with segregated_sm margin model. Multiplying it by future position's market price returns its estimated liquidation price.
The account's balance reserved in other orders
Was this page helpful?