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

Scope: account:read

Try in API console

cURL

cURL

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

import requests

url = "https://test.deribit.com/api/v2/private/get_subaccounts"

payload = {
    "jsonrpc": "2.0",
    "id": 4947,
    "method": "private/get_subaccounts",
    "params": { "with_portfolio": True }
}
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 4947,
    method: 'private/get_subaccounts',
    params: {with_portfolio: true}
  })
};

fetch('https://test.deribit.com/api/v2/private/get_subaccounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.deribit.com/api/v2/private/get_subaccounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    'jsonrpc' => '2.0',
    'id' => 4947,
    'method' => 'private/get_subaccounts',
    'params' => [
        'with_portfolio' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.deribit.com/api/v2/private/get_subaccounts"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 4947,\n  \"method\": \"private/get_subaccounts\",\n  \"params\": {\n    \"with_portfolio\": true\n  }\n}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://test.deribit.com/api/v2/private/get_subaccounts")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 4947,\n  \"method\": \"private/get_subaccounts\",\n  \"params\": {\n    \"with_portfolio\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.deribit.com/api/v2/private/get_subaccounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 4947,\n  \"method\": \"private/get_subaccounts\",\n  \"params\": {\n    \"with_portfolio\": true\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "jsonrpc": "2.0",
  "id": 4947,
  "result": [
    {
      "email": "[e-mail]",
      "id": 2,
      "is_password": true,
      "margin_model": "segregated_sm",
      "login_enabled": true,
      "portfolio": {
        "eth": {
          "additional_reserve": 0,
          "spot_reserve": 0,
          "available_funds": 5,
          "available_withdrawal_funds": 5,
          "balance": 5,
          "currency": "eth",
          "equity": 5,
          "initial_margin": 0,
          "maintenance_margin": 0,
          "margin_balance": 5
        },
        "btc": {
          "additional_reserve": 0,
          "spot_reserve": 0,
          "available_funds": 5.000413075,
          "available_withdrawal_funds": 5.000413075,
          "balance": 5.000593987,
          "currency": "btc",
          "equity": 5.000571846,
          "initial_margin": 0.000158771,
          "maintenance_margin": 0.000115715,
          "margin_balance": 5.000571846
        }
      },
      "receive_notifications": false,
      "system_name": "user_1",
      "security_keys_enabled": false,
      "security_keys_assignments": [],
      "type": "main",
      "username": "user_1"
    },
    {
      "email": "[e-mail]",
      "id": 7,
      "is_password": true,
      "margin_model": "cross_pm",
      "login_enabled": false,
      "portfolio": {
        "eth": {
          "additional_reserve": 0,
          "spot_reserve": 0,
          "available_funds": 0,
          "available_withdrawal_funds": 0,
          "balance": 0,
          "currency": "eth",
          "equity": 0,
          "initial_margin": 0,
          "maintenance_margin": 0,
          "margin_balance": 0
        },
        "btc": {
          "additional_reserve": 0,
          "spot_reserve": 0,
          "available_funds": 0,
          "available_withdrawal_funds": 0,
          "balance": 0,
          "currency": "btc",
          "equity": 0,
          "initial_margin": 0,
          "maintenance_margin": 0,
          "margin_balance": 0
        }
      },
      "receive_notifications": false,
      "system_name": "user_1_1",
      "security_keys_enabled": false,
      "security_keys_assignments": [],
      "type": "subaccount",
      "username": "user_1_1"
    }
  ]
}

{
  "jsonrpc": "2.0",
  "message": "<string>",
  "error": 123,
  "id": 123
}

Query Parameters

with_portfolio · boolean

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

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. username · string · required

result. type · enum<string> · required

Available options: main, subaccount

result. id · integer · required

Account/Subaccount identifier

result. email · string · required

User email

result. system_name · string · required

System generated user nickname

result. receive_notifications · boolean · required

When true - receive all notification emails on the main email

result. is_password · boolean · required

true when password for the subaccount has been configured

result. not_confirmed_email · string

New email address that has not yet been confirmed. This field is only included if with_portfolio == true.

result. security_keys_enabled · boolean

Whether the Security Keys authentication is enabled

result. security_keys_assignments · array

Names of assignments with Security Keys assigned

result. margin_model · string

Margin model

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

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

result. login_enabled · boolean

Informs whether login to the subaccount is enabled

result. portfolio · object

Only if with_portfolio == true

Hide child attributes

result.portfolio. btc(example) · object

Hide child attributes

result.portfolio.btc(example). 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.

result.portfolio.btc(example). currency · enum<string> · required

The selected currency

Available options: btc, eth

result.portfolio.btc(example). 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.

result.portfolio.btc(example). 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.

result.portfolio.btc(example). equity · number · required

The account's current equity

result.portfolio.btc(example). balance · number · required

The account's balance

result.portfolio.btc(example). available_withdrawal_funds · number · required

The account's available to withdrawal funds

result.portfolio.btc(example). 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.

result.portfolio.btc(example). additional_reserve · number · required

The account's balance reserved in other orders

Example:

0.3

result.portfolio.btc(example). spot_reserve · number · required

The account's balance reserved in active spot orders

id · integer

The id that was sent in the request