---
title: "GET /private/get_subaccounts"
method: GET
path: "/private/get_subaccounts"
tags: ["Account Management", "Private"]
---

# GET /private/get_subaccounts

`GET /private/get_subaccounts`

Retrieves information about all subaccounts associated with the main account. Returns details such as subaccount IDs, names, and status.

When called from a subaccount, the response includes limited details for the main account and full details for the subaccount initiating the request.

Set the `with_portfolio` parameter to `true` to include portfolio information (balances, positions, etc.) in the response. By default, only subaccount metadata is returned.

**📖 Related Article:** [Managing Subaccounts](https://docs.deribit.com/articles/managing-subaccounts-api)

**Scope:** `account:read`

[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_subaccounts)

## Query parameters

- `with_portfolio` boolean

## Response `200`

Success response

- PrivateGetSubaccountsResponse
  - `jsonrpc` '2.0', required — The JSON-RPC version (2.0)
  - `id` integer — The id that was sent in the request
  - `result` object[], required
    - `username` string, required
    - `type` 'main' | 'subaccount', required
    - `id` integer, required — Account/Subaccount identifier
    - `email` string, required — User email
    - `not_confirmed_email` string — New email address that has not yet been confirmed. This field is only included if `with_portfolio` == `true`.
    - `security_keys_enabled` boolean — Whether the Security Keys authentication is enabled
    - `security_keys_assignments` unknown[] — Names of assignments with Security Keys assigned
      - unknown
    - `system_name` string, required — System generated user nickname
    - `receive_notifications` boolean, required — When `true` - receive all notification emails on the main email
    - `is_password` boolean, required — `true` when password for the subaccount has been configured
    - `margin_model` string — Margin model
    - `proof_id` string — Hashed identifier used in the Proof Of Liability for the subaccount. This identifier allows you to find your entries in the Deribit Proof-Of-Reserves files. IMPORTANT: Keep it secret to not disclose your entries in the Proof-Of-Reserves.
    - `proof_id_signature` string — Signature used as a base string for proof_id hash. IMPORTANT: Keep it secret to not disclose your entries in the Proof-Of-Reserves.
    - `login_enabled` boolean — Informs whether login to the subaccount is enabled
    - `portfolio` Portfolio
      - `btc(example)` CurrencyPortfolio
        - `margin_balance` number, required — 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.
        - `currency` 'btc' | 'eth', required — The selected currency
        - `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.
        - `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.
        - `equity` number, required — The account's current equity
        - `balance` number, required — The account's balance
        - `available_withdrawal_funds` number, required — The account's available to withdrawal funds
        - `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.
        - `additional_reserve` number, required — The account's balance reserved in other orders
        - `spot_reserve` number, required — The account's balance reserved in active spot orders

## Other responses

- `401` — Success response

---

[API](https://skmtc.net/deribit/apis/deribit-api.md) · [All operations](https://skmtc.net/deribit/apis/deribit-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/deribit/deribit-api/revisions/c254e4a8a23c/schema)