REST
GET
/api/v1/user/balancesGet Balances
Retrieve the current balances of the user's account.
Auth:Bearer <api_key>
Tags:Balances
Request
cURL
curl -G https://publicapi.sandbox.hercle.financial/api/v1/user/balances \
-H "Authorization: Bearer eyJhb..." \
Headers
| Name | Type | Required | Description |
|---|---|---|---|
| Authorization | string | Yes | Bearer token for authentication |
Response
Success Response Schema
User balances retrieved successfully
| Field | Type | Description |
|---|---|---|
userId | string | Unique identifier for the user |
sequence | number | Sequence number for balance updates |
assets | array | List of asset balances |
assets[].name | string | Asset code (e.g., BTC, USDT) |
assets[].available | number | Available balance for trading |
assets[].allocated | number | Balance allocated to open orders |
assets[].currentExposure | number | Current total exposure |
assets[].maxExposure | number | Maximum allowed exposure |
baseCurrency | string | Base currency for exposure calculations |
totalCurrentExposure | number | Total current exposure across all assets |
totalMaxExposure | number | Total maximum exposure allowed across all assets |
deleted | boolean | Indicates if the balance record is deleted |
Responses
User balances retrieved successfully
200 application/json
[
{
"userId": "123e4567-e89b-12d3-a456-426614174000",
"sequence": 42,
"assets": [
{
"name": "BTC",
"available": 1.5,
"allocated": 0.5,
"currentExposure": 2,
"maxExposure": 5
},
{
"name": "USDT",
"available": 10000,
"allocated": 2000,
"currentExposure": 12000,
"maxExposure": 20000
}
],
"baseCurrency": "EUR",
"totalCurrentExposure": 1400,
"totalMaxExposure": 2500,
"deleted": false
}
]API Tester
Test this endpoint directly against the sandbox environment
Get your API key from Hercle Sandbox
https://publicapi.sandbox.hercle.financial/api/v1/user/balances