DEderibit
Account Management
Private

Changed on

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

Scope: account:read

Try in API console

get/private/get_subaccounts

Request

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

Query parameters

with_portfolioboolean
Example:true

Portfolio flag: true for portfolio information, false for subaccount information only. false by default

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Changes

  • 82518876f388Revision changes
    • breaking

      the response's property type changed from integer to object for status

    • breaking

      removed the required property from the response with the status

    • warning

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

    • warning

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

    • warning

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

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status