Account Balances
Manage and monitor your cryptocurrency balances.
Get Account Balances
GET
/user/balances/
Get aggregated cryptocurrency balances including account balances, sub-account balances, and statistics.
Authentication
Requires OAuth 2.0 authentication with read and write scopes.
Example Request
curl -X GET {{BASE_URL}}/user/balances/ \
-H "Authorization: Bearer your_access_token"
Response
Success Response (200 OK)
{
"account": {
"USDTERC20": "5000.000000",
"USDCERC20": "2500.000000",
"ETH": "5.123456"
},
"sub_accounts": {
"USDTERC20": "1500.000000",
"USDCERC20": "800.000000"
},
"statistics": {
"total_deposits": 1234,
"total_withdrawals": 456
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
account | object | Per-currency balances for the main account |
sub_accounts | object | Per-currency balances across sub-accounts |
statistics | object | Account-level transaction statistics |
Error Responses
401 Unauthorized
{
"error": {
"code": "authentication_failed",
"message": "Invalid or missing authentication token",
"details": {}
}
}
Get Balance History
GET
/user/balances/history/
Get historical balance data for analytics and reconciliation.
Authentication
Requires OAuth 2.0 authentication with read scope.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
currency | string | No | Filter by currency code (e.g., "USDTERC20") |
type | string | No | Filter by transaction type |
limit | integer | No | Number of records to return |
offset | integer | No | Number of records to skip (for pagination) |
Example Request
curl -X GET "{{BASE_URL}}/user/balances/history/?currency=USDTERC20&limit=10&offset=0" \
-H "Authorization: Bearer your_access_token"
Response
Success Response (200 OK)
{
"history": [
{
"timestamp": "2025-01-15T09:30:00Z",
"currency": "USDTERC20",
"type": "deposit",
"amount": "500.000000",
"balance_after": "5500.000000"
},
{
"timestamp": "2025-01-14T15:20:00Z",
"currency": "USDTERC20",
"type": "withdrawal",
"amount": "200.000000",
"balance_after": "5000.000000"
}
],
"total": 35,
"limit": 10,
"offset": 0
}
Response Fields
| Field | Type | Description |
|---|---|---|
history | array | List of balance history entries |
total | integer | Total number of matching records |
limit | integer | Number of records returned |
offset | integer | Number of records skipped |