Sign in

v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Account Management
Private

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

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

Example response

{
  "result": [
    {
      "portfolio": {
        "btc(example)": {
          "additional_reserve": 0.3
        }
      }
    }
  ]
}