private/get_account_summaries

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.

Scope: account:read

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/get_account_summaries \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 2515,
  "method": "private/get_account_summaries",
  "params": {
    "extended": true
  }
}
'

200

{
  "jsonrpc": "2.0",
  "id": 2515,
  "result": {
    "id": 10,
    "email": "[e-mail]",
    "system_name": "user",
    "username": "user",
    "block_rfq_self_match_prevention": true,
    "creation_timestamp": 1687352432143,
    "type": "main",
    "referrer_id": null,
    "login_enabled": false,
    "security_keys_enabled": false,
    "mmp_enabled": false,
    "interuser_transfers_enabled": false,
    "self_trading_reject_mode": "cancel_maker",
    "self_trading_extended_to_subaccounts": false,
    "summaries": [
      {
        "currency": "BTC",
        "delta_total_map": {
          "btc_usd": 31.594357699
        },
        "margin_balance": 302.62729214,
        "futures_session_rpl": -0.03258105,
        "options_session_rpl": 0,
        "estimated_liquidation_ratio_map": {
          "btc_usd": 0.1009872222854525
        },
        "session_upl": 0.05271555,
        "estimated_liquidation_ratio": 0.10098722,
        "options_gamma_map": {
          "btc_usd": 0.00001
        },
        "options_vega": 0.0858,
        "options_value": -0.0086,
        "available_withdrawal_funds": 301.35396172,
        "projected_delta_total": 32.613978,
        "maintenance_margin": 0.8857841,
        "total_pl": -0.33084225,
        "limits": {
          "limits_per_currency": false,
          "non_matching_engine": {
            "burst": 1500,
            "rate": 1000
          },
          "matching_engine": {
            "trading": {
              "total": {
                "burst": 250,
                "rate": 200
              }
            },
            "spot": {
              "burst": 250,
              "rate": 200
            },
            "quotes": {
              "burst": 500,
              "rate": 500
            },
            "max_quotes": {
              "burst": 10,
              "rate": 10
            },
            "guaranteed_quotes": {
              "burst": 2,
              "rate": 2
            },
            "cancel_all": {
              "burst": 250,
              "rate": 200
            }
          }
        },
        "projected_maintenance_margin": 0.7543841,
        "available_funds": 301.38059622,
        "options_delta": -1.01962,
        "balance": 302.60065765,
        "equity": 302.61869214,
        "futures_session_upl": 0.05921555,
        "fee_balance": 0,
        "options_session_upl": -0.0065,
        "projected_initial_margin": 1.01529592,
        "options_theta": 15.97071,
        "portfolio_margining_enabled": false,
        "cross_collateral_enabled": false,
        "margin_model": "segregated_sm",
        "options_vega_map": {
          "btc_usd": 0.0858
        },
        "futures_pl": -0.32434225,
        "options_pl": -0.0065,
        "initial_margin": 1.24669592,
        "spot_reserve": 0,
        "delta_total": 31.602958,
        "options_gamma": 0.00001,
        "session_rpl": -0.03258105,
        "fees": {
          "btc_usd": {
            "option": {
              "default": {
                "type": "relative",
                "taker": 0.625,
                "maker": 0.625
              },
              "block_trade": 0.625
            },
            "perpetual": {
              "default": {
                "type": "fixed",
                "taker": 0.00035000000000000005,
                "maker": -0.0001
              },
              "block_trade": 0.3
            },
            "future": {
              "default": {
                "type": "fixed",
                "taker": 0.00035000000000000005,
                "maker": -0.0001
              },
              "block_trade": 0.3
            }
          }
        }
      },
      {
        "currency": "ETH",
        "futures_session_upl": 0,
        "portfolio_margining_enabled": false,
        "available_funds": 99.999598,
        "initial_margin": 0.000402,
        "futures_session_rpl": 0,
        "options_gamma": 0,
        "balance": 100,
        "options_vega_map": {},
        "session_upl": 0,
        "fee_balance": 0,
        "delta_total_map": {
          "eth_usd": 0
        },
        "projected_maintenance_margin": 0,
        "options_gamma_map": {},
        "projected_delta_total": 0,
        "margin_model": "segregated_sm",
        "futures_pl": 0,
        "options_theta": 0,
        "limits": {
          "limits_per_currency": false,
          "non_matching_engine": {
            "burst": 1500,
            "rate": 1000
          },
          "matching_engine": {
            "trading": {
              "total": {
                "burst": 250,
                "rate": 200
              }
            },
            "spot": {
              "burst": 250,
              "rate": 200
            },
            "quotes": {
              "burst": 500,
              "rate": 500
            },
            "max_quotes": {
              "burst": 10,
              "rate": 10
            },
            "guaranteed_quotes": {
              "burst": 2,
              "rate": 2
            },
            "cancel_all": {
              "burst": 250,
              "rate": 200
            }
          }
        },
        "options_delta": 0,
        "equity": 100,
        "projected_initial_margin": 0.0002,
        "estimated_liquidation_ratio_map": {
          "eth_usd": 0
        },
        "spot_reserve": 0.0002,
        "cross_collateral_enabled": false,
        "available_withdrawal_funds": 99.999597,
        "delta_total": 0,
        "options_session_upl": 0,
        "maintenance_margin": 0,
        "options_theta_map": {},
        "additional_reserve": 0,
        "estimated_liquidation_ratio": 0,
        "options_pl": 0,
        "options_session_rpl": 0,
        "options_vega": 0,
        "total_pl": 0,
        "session_rpl": 0,
        "options_value": 0,
        "margin_balance": 100,
        "fees": {
          "eth_usd": {
            "option": {
              "default": {
                "type": "relative",
                "taker": 0.5,
                "maker": 0.5
              },
              "block_trade": 0.5
            },
            "perpetual": {
              "default": {
                "type": "fixed",
                "taker": 0.00025,
                "maker": -0.00005
              },
              "block_trade": 0.2
            },
            "future": {
              "default": {
                "type": "fixed",
                "taker": 0.00025,
                "maker": -0.00005
              },
              "block_trade": 0.2
            }
          }
        }
      }
    ]
  }
}

Query Parameters

subaccount_id · integer

The user id for the subaccount

extended · boolean

Include additional fields

Example:

true

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object · required

Hide child attributes

result. id · integer · required

Account id (available when parameter extended = true)

Example:

12354

result. system_name · string · required

System generated user nickname (available when parameter extended = true)

Example:

"myname"

result. username · string · required

Account name (given by user) (available when parameter extended = true)

Example:

"name"

result. type · enum<string> · required

Account type (available when parameter extended = true)

Available options: main, subaccount

result. email · string · required

User email (available when parameter extended = true)

Example:

"[e-mail]"

result. security_keys_enabled · boolean · required

Whether Security Key authentication is enabled (available when parameter extended = true)

Example:

false

result. login_enabled · boolean

Whether account is loginable using email and password (available when parameter extended = true and account is a subaccount)

Example:

false

result. mmp_enabled · boolean

Whether MMP is enabled (available when parameter extended = true)

Example:

false

result. interuser_transfers_enabled · boolean

true when the inter-user transfers are enabled for user (available when parameter extended = true)

Example:

false

result. referrer_id · string

Optional identifier of the referrer (of the affiliation program, and available when parameter extended = true), which link was used by this account at registration. It coincides with suffix of the affiliation link path after /reg-

Example:

"517.6035"

result. creation_timestamp · integer

Time at which the account was created (milliseconds since the Unix epoch; available when parameter extended = true)

Example:

1542100802842

result. self_trading_reject_mode · string

Self trading rejection behavior - reject_taker or cancel_maker (available when parameter extended = true)

result. self_trading_extended_to_subaccounts · string

true if self trading rejection behavior is applied to trades between subaccounts (available when parameter extended = true)

result. block_rfq_self_match_prevention · string

When Block RFQ Self Match Prevention is enabled, it ensures that RFQs cannot be executed between accounts that belong to the same legal entity. This setting is independent of the general self-match prevention settings and must be configured separately.

result. affiliate_promotion_fee · number

Affiliate promotion fee (if greater than 0.0)

Example:

0

result. trading_products_details · object

Which trading products are enabled or can be overwritten for the account

result. receive_notifications · boolean

Whether the account receives notifications

Example:

false

result. summaries · object[]

Aggregated list of per-currency account summaries

Hide child attributes

result.summaries. total_pl · number · required

Profit and loss

Example:

0.02032221

result.summaries. session_rpl · number · required

Session realized profit and loss

Example:

0.1

result.summaries. session_upl · number · required

Session unrealized profit and loss

Example:

0.846863

result.summaries. available_funds · number · required

The account's available funds. 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.

Example:

2.2638913

result.summaries. available_withdrawal_funds · number · required

The account's available to withdrawal funds

Example:

2.26

result.summaries. balance · number · required

The account's balance

Example:

3.4906363

result.summaries. currency · string · required

Currency of the summary

Example:

"ETH"

result.summaries. delta_total · number · required

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.

Example:

0.1334

result.summaries. projected_delta_total · number · required

The sum of position deltas without positions that will expire during closest expiration

Example:

0.1334

result.summaries. equity · number · required

The account's current equity

Example:

2.6437733

result.summaries. futures_pl · number · required

Futures profit and Loss

Example:

0

result.summaries. futures_session_rpl · number · required

Futures session realized profit and Loss

Example:

0

result.summaries. futures_session_upl · number · required

Futures session unrealized profit and Loss

Example:

0

result.summaries. initial_margin · number · required

The account's initial margin. 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.

Example:

0.379882

result.summaries. maintenance_margin · number · required

The maintenance margin. 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.

Example:

0.1334519

result.summaries. options_delta · number · required

Options summary delta

Example:

0

result.summaries. options_gamma · number · required

Options summary gamma

Example:

0

result.summaries. options_pl · number · required

Options profit and Loss

Example:

0

result.summaries. options_session_rpl · number · required

Options session realized profit and Loss

Example:

0

result.summaries. options_session_upl · number · required

Options session unrealized profit and Loss

Example:

0

result.summaries. options_theta · number · required

Options summary theta

Example:

0

result.summaries. options_value · number · required

Options value

Example:

0

result.summaries. options_vega · number · required

Options summary vega

Example:

0

result.summaries. options_gamma_map · object · required

Map of options' gammas per index

result.summaries. options_theta_map · object · required

Map of options' thetas per index

result.summaries. options_vega_map · object · required

Map of options' vegas per index

result.summaries. projected_maintenance_margin · number · required

Projected maintenance margin. 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.

Example:

1

result.summaries. margin_balance · number

The account's margin balance. 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.

Example:

2.25

result.summaries. spot_reserve · number

The account's balance reserved in active spot orders

Example:

0.3

result.summaries. additional_reserve · number

The account's balance reserved in other orders

Example:

0.3

result.summaries. fee_balance · number

The account's fee balance (it can be used to pay for fees)

result.summaries. 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

result.summaries. deposit_address · string

The deposit address for the account (if available)

Example:

"14diAAyXL5UzhPTCKC998ch2GV7DMb7yDi"

result.summaries. estimated_liquidation_ratio · number

Estimated Liquidation Ratio is returned only for users without portfolio margining enabled. Multiplying it by future position's market price returns its estimated liquidation price. 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.

Example:

0.0000234

result.summaries. projected_initial_margin · number

Projected initial margin. 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.

Example:

1

result.summaries. portfolio_margining_enabled · boolean

true when portfolio margining is enabled for user

Example:

true

result.summaries. cross_collateral_enabled · boolean

When true cross collateral is enabled for user

Example:

true

result.summaries. margin_model · string

Name of user's currently enabled margin model

Example:

"segregated_sm"

result.summaries. total_equity_usd · number

Optional (only for users using cross margin). The account's total equity in all cross collateral currencies, expressed in USD

Example:

2.6437733

result.summaries. 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

Example:

0.379882

result.summaries. 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

Example:

0.1334519

result.summaries. 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

Example:

2.25

result.summaries. 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

Example:

1.8

result.summaries. limits · object

Returned object is described in separate document.

result.summaries. 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

result.summaries. fees · object

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).

Hide child attributes

result.summaries.fees. {key} · object

Hide child attributes

result.summaries.fees.{key}. {key} · object

Hide child attributes

result.summaries.fees.{key}.{key}. default · object · required

Hide child attributes

result.summaries.fees.{key}.{key}.default. type · string · required

Fee calculation type (e.g., fixed, relative)

result.summaries.fees.{key}.{key}.default. taker · number · required

Taker fee

result.summaries.fees.{key}.{key}.default. maker · number · required

Maker fee

result.summaries.fees.{key}.{key}. block_trade · number

Block trade fee (if applicable)

result.summaries. affiliate_promotion_fee · number

Affiliate promotion fee (if greater than 0.0)

Example:

0

result.summaries. trading_products_details · object

Which trading products are enabled or can be overwritten for the account

result.summaries. receive_notifications · boolean

Whether the account receives notifications

Example:

false

id · integer

The id that was sent in the request