Get MT5 Balance

Developing

GET

/platform/mt5/user-balance

get_mt5_balance

Last modified:2025-02-24 07:00:13

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api-core.deriv.com/v1/platform/mt5/user-balance?is_demo=false&platform_account_id={{CLIENT_DEMO_MT5_ACC_ID}}' \
--header 'Authorization: {{CLIENT_AUTH_TOKEN}}' \
--header 'x-client-id: {{RL_EXCLUSION_KEY}}'

Response Example

{
  "data": [
    {
      "balance": 0
    }
  ],
  "meta": {
    "endpoint": "string",
    "method": "string",
    "timing": 0
  }
}

Request

Query Params

is_demo

string

optional

Example:

false

platform_account_id

string

optional

Example:

Header Params

Authorization

string

optional

Example:

x-client-id

string

optional

Optional only required for internal systems referrence.

Default:

Responses

🟢200Success

application/json

Body

data

array [object {1}]

required

balance

integer

optional