Skip to main content

Get direct customers asset balance

info
  • Returns total balance per user + coin in the original coin (no conversion).

API rate limit: 5 req / sec

HTTP Request

GET /private/v1/broker/asset-balance

Request Parameters

ParameterRequiredTypeComments
uidfalsestring
  • Pass a direct customer UID to query that user only
  • Omit to return all direct customers under the broker (still paginated by UID)
coinfalsestringCoin filter: omit for all coins per UID; set to keep only that coin per UID
cursorfalsestringCursor for UID pagination; omit on the first request
limitfalseintegerMax UIDs per page, in [1, 50], default 20

Response Parameters

ParameterTypeComments
listarrayOne element per UID in this page
> user_idstringDirect customer UID
> coinsarrayPer-coin balances
> > coinstringCoin
> > total_balancestringTotal amount in this coin; semantics per business rules
next_cursorstringCursor for the next UID page; empty when no more UIDs

Request Example

import time
import hmac
import hashlib
import requests
import urllib.parse

def create_request(apiKey, secret, params):
url = 'https://openapi-testnet.zoomex.com/private/v1/broker/asset-balance'
timestamp = int(time.time() * 1000)
recv_window = 1000000

params['api_key'] = apiKey
params['timestamp'] = timestamp
params['recv_window'] = recv_window

ordered_params = '&'.join([f"{key}={params[key]}" for key in sorted(params.keys())])

signature = hmac.new(secret.encode('utf-8'), ordered_params.encode('utf-8'), hashlib.sha256).hexdigest()

params['sign'] = signature

headers = {
'X-BAPI-API-KEY': apiKey,
'X-BAPI-SIGN': signature,
'X-BAPI-TIMESTAMP': str(timestamp),
'X-BAPI-RECV-WINDOW': str(recv_window)
}

query_string = urllib.parse.urlencode(params)
full_url = f"{url}?{query_string}"

response = requests.get(full_url, headers=headers)

print("response status:", response.status_code)
print("response info:", response.json())
print("response time:", response.elapsed.total_seconds())

apiKey = 'your key'
secret = 'your secret'
params = {
"limit": 20,
}

create_request(apiKey, secret, params)

Response Example

{
"ret_code": 0,
"ret_msg": "OK",
"ext_code": "",
"result": {
"list": [
{
"user_id": "101479471",
"coins": [
{
"coin": "USDT",
"total_balance": "1000.25"
}
]
}
],
"next_cursor": ""
},
"ext_info": null,
"time_now": 1718353045150
}