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": {}
}
'

{
  "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
        }
      ]
    }
  ]
}

Block Trade

private/get_broker_clients

Broker Method Returns a list of clients registered under the broker account. Each client record includes:

client_id — a numeric identifier that groups one or more linked users under a single client name. Use this value in other Broker Voice API calls (e.g. private/execute_broker_trade) to identify the client group.
links — an array of individual user connections belonging to that client. Each link contains a client_link_id that uniquely identifies a single user within the client group.

How to obtain client_id and client_link_id

Call this endpoint without parameters to retrieve all clients. Locate the client by name or company, read client_id from the top-level object, and read client_link_id from the relevant entry in the links array. Use these two values together in subsequent Broker Voice API calls to specify which user within a client should be the counterparty.

A link state of connected means the user has accepted the broker invitation and is ready to trade. Links in pending state have not yet been accepted; links in rejected state are inactive.

Optionally filter by a specific client_id to return only that client’s record, or set include_subaccounts to true to include clients managed by broker sub-accounts.

Scope: block_trade:read

Try in API console

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": {}
}
'

{
  "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

Hide child attributes

result.client_id

integer

required

Numeric identifier for the client group. Used in Broker Voice API calls to reference this client.

result.client_name

string

required

Name of the client.

result.company_name

string

required

Company name of the client.

result.broker_code

string

required

Broker-assigned code used in invitation links for this client.

result.links

object[]

required

Array of individual user connections belonging to this client.

Hide child attributes

result.links.client_link_id

integer

required

Numeric identifier for an individual user within the client group. Used together with client_id in Broker Voice API calls.

result.links.user_id

string

required

Obscured user ID of the linked user.

result.links.name

string

required

Display name for this link.

result.links.state

enum<string>

required

Connection state of the link: connected (user accepted the invitation and is active), pending (invitation sent, not yet accepted), or rejected (link is inactive).

Available options:

connected,

pending,

rejected

result.links.confirmations_required

integer

required

Number of broker confirmations required for block trades involving this link.

result.links.note

string

Optional note attached to this link.

result.links.broker_sub_user_id

integer

ID of the broker sub-account managing this link, if applicable.

result.main_user_id

string

Obscured user ID of the main account linked to this client, if any.

result.broker_sub_user_id

integer

ID of the broker sub-account that manages this client, if applicable.

result.lei

string

Legal Entity Identifier (LEI) of the client, if provided.

result.brn

string

Business Registration Number (BRN) of the client, if provided.

integer

The id that was sent in the request

private/get_block_trades private/get_broker_trade_requests

⌘I