Interface: AdvTradeGlobalGetAccountSummaryResult
Properties
| Property | Type | Description |
|---|---|---|
additional_reserve? | number | The 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_funds | number | Funds 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_funds | number | Funds 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. |
balance | number | The 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. |
block_rfq_self_match_prevention? | boolean | When enabled, Block RFQ self-match prevention stops RFQ execution between accounts under the same legal entity. Independent of general self-match prevention (available when parameter extended = true). |
close_out_margin? | number | Close-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. |
creation_timestamp? | number | Time at which the account was created (milliseconds since the Unix epoch; available when parameter extended = true) |
cross_collateral_enabled? | boolean | When true cross collateral is enabled for user |
currency | string | The selected currency |
delta_total | number | 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. |
delta_total_map? | AdvTradeGlobalDeltaTotalMap | Map 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? | string | The deposit address for the account (if available) |
email | string | User email (available when parameter extended = true) |
equity | number | The 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? | number | The account's fee balance (it can be used to pay for fees) |
fee_group? | string | Fee 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? | AdvTradeGlobalFees | Fee 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_pl | number | Combined profit and loss of all futures and perpetual positions included in total_pl (total_pl - options_pl). |
futures_session_rpl | number | Session realized profit and loss for futures and perpetual positions (resets at daily settlement). |
futures_session_upl | number | Session unrealized profit and loss for open futures and perpetual positions. |
has_non_block_chain_equity? | boolean | Optional field returned with value true when user has non block chain equity that is excluded from proof of reserve calculations |
id | number | Account id (available when parameter extended = true) |
initial_margin | number | Minimum 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. |
interuser_transfers_enabled? | boolean | true when the inter-user transfers are enabled for user (available when parameter extended = true) |
is_direct_access_allowed? | boolean | Whether Direct Access trading is enabled for the account. |
limits? | object | Returned object is described in separate document. |
locked_balance? | number | Portion of the account balance that is locked and excluded from available withdrawal calculations. |
login_enabled? | boolean | Whether account is loginable using email and password (available when parameter extended = true and account is a subaccount) |
maintenance_margin | number | Minimum 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? | number | Collateral 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? | string | Name of user's currently enabled margin model |
mmp_enabled? | boolean | Whether MMP is enabled (available when parameter extended = true) |
options_delta | number | Sum 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_gamma | number | Sum of options position gammas (Black-Scholes). |
options_gamma_map | AdvTradeGlobalOptionsGammaMap | Map of options' gammas per index |
options_pl | number | Combined profit and loss of all options positions included in total_pl. |
options_session_rpl | number | Session realized profit and loss for options positions (resets at daily settlement). |
options_session_upl | number | Session unrealized profit and loss for open options positions. |
options_theta | number | Sum 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_map | AdvTradeGlobalOptionsThetaMap | Map of options' thetas per index |
options_value | number | Mark value of all open options positions in the selected currency. Under standard margin, margin_balance = equity - options_value. |
options_vega | number | Sum of options position vegas (Black-Scholes). |
options_vega_map | AdvTradeGlobalOptionsVegaMap | Map of options' vegas per index |
portfolio_margining_enabled? | boolean | true when portfolio margining is enabled for user |
projected_close_out_margin? | number | Close-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_total | number | The 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? | number | Initial 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_margin | number | Maintenance 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? | boolean | Whether the account receives notifications |
security_keys_enabled | boolean | Whether Security Key authentication is enabled (available when parameter extended = true) |
self_trading_extended_to_subaccounts? | string | true if self trading rejection behavior is applied to trades between subaccounts (available when parameter extended = true) |
self_trading_reject_mode? | string | Self trading rejection behavior - reject_taker or cancel_maker (available when parameter extended = true) |
session_rpl | number | Realized profit and loss accrued in the current trading session (since the last daily settlement). Resets at each daily settlement. |
session_upl | number | Unrealized profit and loss on open positions in the current trading session (since the last daily settlement). |
spot_reserve? | number | The account's balance reserved in active spot orders |
system_name | string | System generated user nickname (available when parameter extended = true) |
total_delta_total_usd? | number | Optional (only for users using cross margin). The account's total delta total in all cross collateral currencies, expressed in USD |
total_equity_usd? | number | Optional (only for users using cross margin). The account's total equity in all cross collateral currencies, expressed in USD |
total_initial_margin_usd? | number | Optional (only for users using cross margin). The account's total initial margin in all cross collateral currencies, expressed in USD |
total_maintenance_margin_usd? | number | Optional (only for users using cross margin). The account's total maintenance margin in all cross collateral currencies, expressed in USD |
total_margin_balance_usd? | number | Optional (only for users using cross margin). The account's total margin balance in all cross collateral currencies, expressed in USD |
total_pl | number | Total 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? | object | Which trading products are enabled or can be overwritten for the account |
type | "main" | "subaccount" | Account type (available when parameter extended = true) |
username | string | Account name (given by user) (available when parameter extended = true) |