Skip to main content
cURL
curl --request GET \
  --url https://test.deribit.com/api/v2/private/get_broker_clients \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "private/get_broker_clients",
  "params": {}
}
'
import requests

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

payload = {
"jsonrpc": "2.0",
"id": 1,
"method": "private/get_broker_clients",
"params": {}
}
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: 1, method: 'private/get_broker_clients', params: {}})
};

fetch('https://test.deribit.com/api/v2/private/get_broker_clients', 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_broker_clients",
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' => 1,
'method' => 'private/get_broker_clients',
'params' => [

]
]),
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_broker_clients"

payload := strings.NewReader("{\n \"jsonrpc\": \"2.0\",\n \"id\": 1,\n \"method\": \"private/get_broker_clients\",\n \"params\": {}\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_broker_clients")
.header("Content-Type", "application/json")
.body("{\n \"jsonrpc\": \"2.0\",\n \"id\": 1,\n \"method\": \"private/get_broker_clients\",\n \"params\": {}\n}")
.asString();
require 'uri'
require 'net/http'

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

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\": 1,\n \"method\": \"private/get_broker_clients\",\n \"params\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": [
    {
      "client_id": 1,
      "client_name": "Acme Trading Ltd",
      "company_name": "Acme Trading Ltd",
      "broker_code": "ACME01",
      "main_user_id": "***456",
      "links": [
        {
          "client_link_id": 1,
          "user_id": "***456",
          "name": "Main Trader",
          "note": "Primary trading account",
          "state": "connected",
          "confirmations_required": 1
        },
        {
          "client_link_id": 2,
          "user_id": "***789",
          "name": "Sub Trader",
          "note": "",
          "state": "pending",
          "confirmations_required": 1
        }
      ]
    },
    {
      "client_id": 2,
      "client_name": "Beta Capital",
      "company_name": "Beta Capital GmbH",
      "broker_code": "BETA01",
      "links": [
        {
          "client_link_id": 3,
          "user_id": "***012",
          "name": "Portfolio Manager",
          "note": "",
          "state": "connected",
          "confirmations_required": 2
        }
      ]
    }
  ]
}

Query Parameters

client_id
integer

If provided, returns only the client with this ID. Omit to return all clients.

include_subaccounts
boolean

If true, includes clients managed by broker sub-accounts. Default: false.

Response

200 - application/json

Success response

jsonrpc
enum<string>
required

The JSON-RPC version (2.0)

Available options:
2.0
result
object[]
required
id
integer

The id that was sent in the request