Skip to content

Interface: AdvTradeGlobalSummaries ​

Properties ​

PropertyTypeDescription
additional_reserve?numberThe account's balance reserved for open buy option orders and option combo orders (the premium payable if they fill). Only non-zero on the cross_sm margin model; balance reserved by spot orders is reported separately in spot_reserve.
available_fundsnumberFunds available to increase margin usage (open or enlarge positions). Equal to margin_balance - initial_margin, floored at 0 in the API response. When initial margin usage exceeds 100%, this is 0 and only reducing orders can be placed. 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.
available_withdrawal_fundsnumberFunds available to withdraw in the selected currency. Typically lower than available_funds because withdrawals also exclude positive session profit, locked balance, spot_reserve, additional_reserve, and non-withdrawable external/implied equity components. Always ≥ 0.
balancenumberThe account's cash balance in the selected currency (deposits, withdrawals, transfers, option premiums, settlements/deliveries, corrections, costs, and insurance refills). Does not include open futures PnL or options mark value.
close_out_margin?numberClose-out margin threshold in the selected currency, equal to 50% of the positional maintenance margin. Because it sits below maintenance_margin, it marks a later and more severe stage than ordinary liquidation: when margin_balance falls to or below this level, close-out liquidation takes over. On a cross account with an outstanding loan it is not exactly half of the reported maintenance_margin: the loan's maintenance margin is included in maintenance_margin but excluded from the close-out threshold. Returned only when close-out margin is enabled on the platform.
cross_collateral_enabled?booleanWhen true cross collateral is enabled for user
currencystringCurrency of the summary
delta_totalnumberThe 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.
delta_total_map?AdvTradeGlobalDeltaTotalMapMap of position delta sums by price index (e.g. btc_usd), covering both futures and options positions. These are raw position deltas: they are not price-adjusted for linear instruments and the options mark value is not subtracted. They therefore do not add up to delta_total, which is calculated on the Net Transaction Delta basis described under delta_total.
deposit_address?stringThe deposit address for the account (if available)
equitynumberThe account's equity in the selected currency: balance + futures (session UPL + RPL) + options mark value (plus any external/implied equity). Related: margin_balance excludes options mark value under standard margin.
fee_balance?numberThe account's fee balance (it can be used to pay for fees)
fee_group?stringFee group indicates the level of fee discounts applied to an account. Use extended: true to view this field. If the field is missing, the account is not assigned to any fee group. 📖 Related Support Article: Automatically applied volume based fee discounts
fees?AdvTradeGlobalFeesFee structure for all currency pairs and instrument types related to the currency (available when parameter extended = true and user has any discounts). Keys are index names (e.g., "btc_usd"), values are objects with instrument types as keys (option, perpetual, future).
futures_plnumberCombined profit and loss of all futures and perpetual positions included in total_pl (total_pl - options_pl).
futures_session_rplnumberSession realized profit and loss for futures and perpetual positions (resets at daily settlement).
futures_session_uplnumberSession unrealized profit and loss for open futures and perpetual positions.
has_non_block_chain_equity?booleanOptional field returned with value true when user has non block chain equity that is excluded from proof of reserve calculations
initial_marginnumberMinimum margin required to open or increase positions (includes margin for open orders). If initial margin usage exceeds 100%, available_funds is 0. 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.
limits?objectReturned object is described in separate document.
locked_balance?numberPortion of the account balance that is locked and excluded from available withdrawal calculations.
maintenance_marginnumberMinimum margin required to keep positions open. If margin_balance falls below maintenance margin, positions are liquidated. 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.
margin_balance?numberCollateral available against margin requirements. Under standard margin (SM): equity - options_value (cash balance plus futures session UPL and RPL). Under portfolio margin (PM): equal to equity on a segregated account, and equity - outstanding_loan_amount on a cross account. 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.
margin_model?stringName of user's currently enabled margin model
options_deltanumberSum of the deltas of all options positions. For inverse (coin-margined) options this is the Black-Scholes delta; for linear options it is the index-price-adjusted delta. Unlike account-level delta_total, the options mark value is not subtracted.
options_gammanumberSum of options position gammas (Black-Scholes).
options_gamma_mapAdvTradeGlobalOptionsGammaMapMap of options' gammas per index
options_plnumberCombined profit and loss of all options positions included in total_pl.
options_session_rplnumberSession realized profit and loss for options positions (resets at daily settlement).
options_session_uplnumberSession unrealized profit and loss for open options positions.
options_thetanumberSum of the thetas of all options positions. Theta is expressed per day; for options with less than one day left to expiry it is scaled down to the fraction of a day remaining.
options_theta_mapAdvTradeGlobalOptionsThetaMapMap of options' thetas per index
options_valuenumberMark value of all open options positions in the selected currency. Under standard margin, margin_balance = equity - options_value.
options_veganumberSum of options position vegas (Black-Scholes).
options_vega_mapAdvTradeGlobalOptionsVegaMapMap of options' vegas per index
portfolio_margining_enabled?booleantrue when portfolio margining is enabled for user
projected_close_out_margin?numberClose-out margin calculated as if instruments expiring at the nearest expiration were excluded, i.e. 50% of the projected positional maintenance margin. As with close_out_margin, the loan maintenance margin counted in projected_maintenance_margin is excluded here, so on a cross account with an outstanding loan the two are not exactly proportional. Returned only when close-out margin is enabled on the platform.
projected_delta_totalnumberThe sum of position deltas excluding positions that expire at the nearest expiration, so it shows the delta that will remain once those positions have expired. Calculated on the same Net Transaction Delta basis as delta_total, including delta decay during the settlement period.
projected_initial_margin?numberInitial margin calculated as if instruments expiring at the nearest expiration were excluded, so it shows the requirement that will remain once those instruments have expired. 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_marginnumberMaintenance margin calculated as if instruments expiring at the nearest expiration were excluded, so it shows the requirement that will remain once those instruments have expired. 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.
receive_notifications?booleanWhether the account receives notifications
session_rplnumberRealized profit and loss accrued in the current trading session (since the last daily settlement). Resets at each daily settlement.
session_uplnumberUnrealized profit and loss on open positions in the current trading session (since the last daily settlement).
spot_reserve?numberThe account's balance reserved in active spot orders
total_delta_total_usd?numberOptional (only for users using cross margin). The account's total delta total in all cross collateral currencies, expressed in USD
total_equity_usd?numberOptional (only for users using cross margin). The account's total equity in all cross collateral currencies, expressed in USD
total_initial_margin_usd?numberOptional (only for users using cross margin). The account's total initial margin in all cross collateral currencies, expressed in USD
total_maintenance_margin_usd?numberOptional (only for users using cross margin). The account's total maintenance margin in all cross collateral currencies, expressed in USD
total_margin_balance_usd?numberOptional (only for users using cross margin). The account's total margin balance in all cross collateral currencies, expressed in USD
total_plnumberTotal profit and loss of all open positions since each position was opened (not limited to the current session). Differs from session_rpl + session_upl, which reset at daily settlement.
trading_products_details?objectWhich trading products are enabled or can be overwritten for the account

Built by Siebly. Open source SDKs for exchange APIs.