Hercle
REST
GET/api/v1/user/balances

Get 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

NameTypeRequiredDescription
AuthorizationstringYesBearer token for authentication

Response

Success Response Schema

FieldTypeDescription
userIdstringUnique identifier for the user
sequencenumberSequence number for balance updates
assetsarrayList of asset balances
assets[].namestringAsset code (e.g., BTC, USDT)
assets[].availablenumberAvailable balance for trading
assets[].allocatednumberBalance allocated to open orders
assets[].currentExposurenumberCurrent total exposure
assets[].maxExposurenumberMaximum allowed exposure
baseCurrencystringBase currency for exposure calculations
totalCurrentExposurenumberTotal current exposure across all assets
totalMaxExposurenumberTotal maximum exposure allowed across all assets
deletedbooleanIndicates 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