Api aggregated account summary response
ApiAggregatedAccountSummaryResponse
The aggregated account summary, that reports the total equity and spot balances of a funding (main) account, and its constituent trading (sub) accounts
Name
Lite |
Type |
Required
Default |
Description |
result
r |
AggregatedAccountSummary |
True |
The aggregated account summary |
AggregatedAccountSummary
Name
Lite |
Type |
Required
Default |
Description |
main_account_id
ma |
string |
True |
The main account ID of the account to which the summary belongs |
total_equity
te |
string |
True |
Total equity of the main (+ sub) account, denominated in USD |
spot_balances
sb |
[SpotBalance] |
True |
The list of spot assets owned by this main (+ sub) account, and their balances |
vault_investments
vi |
[VaultInvestment] |
True |
The list of vault investments held by this main account |
total_sub_account_balance
ts |
string |
True |
Deprecated: Use totalSubAccountEquity instead |
total_sub_account_equity
ts1 |
string |
True |
Total equity of the sub accounts, denominated in USD |
total_vault_investments_balance
tv |
string |
True |
Total amount of the vault investments, denominated in USD |
total_sub_account_available_balance
ts2 |
string |
True |
Total available balance of the main account, denominated in USD |
total_usd_notional_invested
tu |
string |
True |
Total entry (initial investment) amount of the open investments, denominated in USD |
SpotBalance
Name
Lite |
Type |
Required
Default |
Description |
currency
c |
string |
True |
The currency you hold a spot balance in |
balance
b |
string |
True |
This currency's balance in this trading account. |
index_price
ip |
string |
True |
The index price of this currency. (reported in USD) |
entry_price
ep |
string |
True |
The entry price of this spot currency. (reported in USD) |
realized_pnl
rp |
string |
True |
The realized PnL of this spot currency. (reported in USD) |
unrealized_pnl
up |
string |
True |
The unrealized PnL of this spot currency. (reported in USD) |
available_to_transfer
at |
string |
True |
The available to transfer amount of this spot currency. |
VaultInvestment
Summarizes a vault investment held by a funding account
Name
Lite |
Type |
Required
Default |
Description |
vault_id
vi |
string |
True |
The trading account ID of the vault invested in. |
num_lp_tokens
nl |
string |
True |
The number of shares held by the investor. |
share_price
sp |
string |
True |
The current share price (in USD) of this vault investment. |
usd_notional_invested
un |
string |
True |
The USD notional invested in this vault investment. |