Get Account Balance

API Description

Retrieves account balance information for the authenticated user. This endpoint provides detailed balance data including available balance, used margin, and total equity across all trading accounts.

HTTP Request

GET /v5/account/wallet-balance

Request Parameters

Parameter
Type
Required
Description

symbol

string

No

Coin name (e.g., USDT, BTC)

Response Parameters

Parameter
Type
Description

symbol

string

Asset symbol (e.g., USDM)

address

string

Asset contract address

decimals

number

Asset decimal places

balance

string

Current balance amount

pendingBalance

object

Pending balance information

-> amount

string

Pending amount

-> exemption

string

Exemption amount

blockInfo

object

Block information

-> height

number

Block height

-> timestamp

number

Block timestamp

Request Example

cURL

curl -X GET \
  'https://api.synfutures.com/v5/account/wallet-balance?accountType=UNIFIED' \
  -H 'Content-Type: application/json' \
  -H 'X-BAPI-API-KEY: [api_key]' \
  -H 'X-BAPI-SIGN: [signature]' \
  -H 'X-BAPI-TIMESTAMP: [timestamp]' \
  -H 'X-BAPI-RECV-WINDOW: 5000'

JavaScript (Fetch)

const response = await fetch(
    "https://api.synfutures.com/v5/account/wallet-balance?accountType=UNIFIED",
    {
        method: "GET",
        headers: {
            "Content-Type": "application/json",
            "X-BAPI-API-KEY": "[api_key]",
            "X-BAPI-SIGN": "[signature]",
            "X-BAPI-TIMESTAMP": "[timestamp]",
            "X-BAPI-RECV-WINDOW": "5000",
        },
    }
);

const data = await response.json();
console.log(data);

Python (requests)

import requests

url = "https://api.synfutures.com/v5/account/wallet-balance"
params = {
    'accountType': 'UNIFIED'
}
headers = {
    'Content-Type': 'application/json',
    'X-BAPI-API-KEY': '[api_key]',
    'X-BAPI-SIGN': '[signature]',
    'X-BAPI-TIMESTAMP': '[timestamp]',
    'X-BAPI-RECV-WINDOW': '5000'
}

response = requests.get(url, headers=headers, params=params)
result = response.json()
print(result)

Response Example

Success Response

{
    "data": [
        {
            "symbol": "USDM",
            "address": "0x8da593b1084727dd82212a0b812415851f29cdec",
            "decimals": 6,
            "balance": "681224628",
            "pendingBalance": {
                "amount": "0",
                "exemption": "0"
            },
            "blockInfo": {
                "height": 162708,
                "timestamp": 1761278396
            }
        }
    ],
    "msg": "",
    "code": 200,
    "requestId": "7397e577-65d1-41d8-9ffe-499b2f322ed0"
}

Error Response

{
    "code": 400,
    "msg": "Request parameter error",
    "data": {},
    "requestId": "7397e577-65d1-41d8-9ffe-499b2f322ed0"
}

Last updated