Read a client's on-chain balance

The balance held by the Base smart wallet of the client selected by X-Hevn-Account, one row per settlement token.

GET /client/balance

Read a client's on-chain balance

cURL

curl --request GET \
  --url https://api.hevn.finance/dapi/v1/client/balance \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Hevn-Account: <x-hevn-account>'

200

{
  "clientId": "cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "totalUsd": "500.00",
  "baseSmartWallet": "<string>",
  "tokens": [
    {
      "token": "USDC",
      "balance": "500.00",
      "usdValue": "500.00"
    }
  ]
}

Authorizations

Authorization · string · header · required

Platform access token from POST /auth/token, carrying the platform audience and the developer_key_id of the registration that minted it. It acts as your own account; name a client you created with X-Hevn-Account: cl_…. Every request re-checks that the registration is still active and that the caller's source IP is inside its allowlist. A token is valid only against the server that issued it, so sandbox tokens are refused in production and production tokens in the sandbox.

Headers

X-Hevn-Account · string · required

The selected client account, as a cl_… id.

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

x-api-key · string | null

Response

200

application/json

Successful Response

clientId · string · required

Account associated with this balance.

Pattern: ^(?:cl_)?[A-Za-z0-9._:\-]{1,216}$

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

totalUsd · string · required

Indicative total balance converted to USD.

Example:

"500.00"

baseSmartWallet · string | null

Base smart-wallet address controlled by the account.

tokens · TokenBalanceView · object[]

Balances grouped by supported digital asset.

Show child attributes