Account Management
Private

Changed on

Retrieves a per-currency list of account summaries for the authenticated user. Each summary includes balance, equity, available funds, and margin information for each currency.

To retrieve summaries 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. Prefer this method over looping private/get_account_summary per currency.

📖 Related Article: Using the currency Parameter

Scope: account:read

Try in API console

get/private/get_account_summaries

Request

  • Base URL
    https://test.deribit.com/api/v2
  • URL
    https://test.deribit.com/api/v2/private/get_account_summaries
  • Auth
    none declared

Query parameters

subaccount_idinteger

The user id for the subaccount

extendedboolean
Example:true

Include additional fields

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": {
    "id": 12354,
    "system_name": "myname",
    "username": "name",
    "email": "support@deribit.com",
    "referrer_id": "517.6035",
    "creation_timestamp": 1542100802842,
    "summaries": [
      {
        "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",
        "equity": 2.6437733,
        "initial_margin": 0.379882,
        "maintenance_margin": 0.1334519,
        "projected_initial_margin": 1,
        "projected_maintenance_margin": 1,
        "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
      }
    ]
  }
}

Changes

  • 8dfbbe9fdddfRevision changes
    • breaking

      the / response's property type changed from string to boolean for status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • 6e5c000c82a8Revision changes
    • warning

      removed the optional property /// from the response with the status