v3
latestOpenAPI 3.0.02026-07-311784111.3 MBAccount Management
Private
Retrieves the account summary for a specific currency. The summary includes balance, equity, available funds, initial margin, maintenance margin, and other margin-related information.
To retrieve the summary for a specific subaccount, use the subaccount_id parameter. When the extended parameter is set to true, additional account details such as account ID, username, email, and account type are included.
Scope: account:read
get/private/get_account_summary
Query parameters
currency'BTC' | 'ETH' | 'STETH' | 'ETHW' | 'USDC' | 'USDT' | 'EURR' | 'SOL' | 'XRP' | 'USYC' | 'PAXG' | 'BNB' | 'USDE' required
Currency, i.e "BTC", "ETH", "USDC"
The currency symbol
subaccount_idinteger
The user id for the subaccount
extendedboolean
Example:true
Include additional fields
Response
Success response
Example response
{
"result": {
"total_pl": 0.02032221,
"session_rpl": 0.1,
"session_upl": 0.846863,
"available_funds": 2.2638913,
"available_withdrawal_funds": 2.26,
"margin_balance": 2.25,
"balance": 3.4906363,
"spot_reserve": 0.3,
"additional_reserve": 0.3,
"currency": "ETH",
"delta_total": 0.1334,
"projected_delta_total": 0.1334,
"deposit_address": "14diAAyXL5UzhPTCKC998ch2GV7DMb7yDi",
"email": "support@deribit.com",
"equity": 2.6437733,
"initial_margin": 0.379882,
"maintenance_margin": 0.1334519,
"estimated_liquidation_ratio": 0.0000234,
"system_name": "myname",
"projected_initial_margin": 1,
"projected_maintenance_margin": 1,
"username": "name",
"id": 12354,
"portfolio_margining_enabled": true,
"cross_collateral_enabled": true,
"margin_model": "segregated_sm",
"total_equity_usd": 2.6437733,
"total_initial_margin_usd": 0.379882,
"total_maintenance_margin_usd": 0.1334519,
"total_margin_balance_usd": 2.25,
"total_delta_total_usd": 1.8,
"referrer_id": "517.6035",
"creation_timestamp": 1542100802842
}
}