v1
latestOpenAPI 3.0.22026-07-26123510445.2 KBBalances
List Balances
Retrieves the balance of funds that are available for banking accounts.
get/v1/balances
Query parameters
page_sizeinteger required
Example:10
The maximum number of items to return per page. This number can be between 1 - 100
page_numberinteger required
Example:1
The page number to retrieve the next set of items. The number has to be greater than 1.
Headers
x-on-behalf-ofstring
Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.
Response
OK - Balances returned successfully.
Example response
{
"total_pages": 10,
"total_items": 105,
"data": [
{
"balance_id": "72970a7c-7921-431c-b95f-3438724ba16f",
"currency": "USD",
"available_balance": "5000.25",
"prepaid_balance": "3600.12",
"margin_balance": "10000.00",
"frozen_balance": "2353.25",
"create_time": "2024-03-01T00:00:00+08:00",
"last_trade_time": "2024-03-21T17:17:32+08:00",
"balance_status": "ACTIVE"
}
]
}