THIS SITE IS UNDER CONSTRUCTION

Deriv Core API

Get Client Accounts

Testing

GET

/client/accounts

get_client_accounts

Last modified:2025-02-06 08:23:13

This endpoint is used to get the list of accounts associated with the client.

Request

Query Params

real_only

string

optional

Example:

true

Header Params

Authorization

string

optional

Example:

x-client-id

string

optional

Optional only required for internal systems referrence.

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/client/accounts?real_only=true' \
--header 'Authorization: {{CLIENT_AUTH_TOKEN}}' \
--header 'x-client-id: {{RL_EXCLUSION_KEY}}'

Responses

🟢200OK

application/json

Body

data

array [object {7}]

required

platform_account_id

string

optional

currency

string

optional

metadata

object

optional

account

object

optional

platform

object

optional

balance

string

optional

image

string

optional

meta

object

required

endpoint

string

required

method

string

required

timing

integer

required

Example

{
  "data": [
    {
      "platform_account_id": "10****6",
      "currency": "USD",
      "metadata": {
        "type": "standard",
        "group": "real\\\\p01_ts01\\\\champion\\\\dsvg_default_usd"
      },
      "account": {
        "id": 101,
        "counterparty": {
          "code": "dsvg",
          "name": "Deriv (SVG) LLC"
        }
      },
      "platform": {
        "code": "p01_ts01",
        "provider": "MT5",
        "description": "MT5 P01TS01",
        "platform_type": "real"
      },
      "balance": "10.00",
      "image": "https://cxkniazywwppajbpagch.supabase.co/storage/v1/object/public/accounts-assets/standard_mt5.svg"
    }
  ],
  "meta": {
    "endpoint": "/client/accounts",
    "method": "GET",
    "timing": 2082
  }
}

🟠401Unauthorized

Modified at 2025-02-06 08:23:13

Create Client Address

Update Profile