Read a client's balances

One row per account the client holds: the tokens on the Base smart wallet of the client selected by X-Hevn-Account, plus any custodial balance. A custodial row is read live from the provider that holds it and is left out when that provider cannot be reached.

GET /client/balance

Read a client's balances

cURL

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

200

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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.

accounts · AccountBalanceView · object[]

One entry per account the client holds a balance on.

Show child attributes