HEhel
Withdrawals

Get Withdrawal Balances

Changed on

Returns on-chain balances for a wallet address against the withdrawal config's source currencies. No authentication required (rate-limited, cached ~5s).

get/v1/withdraw/{withdrawalConfigId}/balances

Request

  • Base URL
    https://api.hel.io
  • URL
    https://api.hel.io/v1/withdraw/{withdrawalConfigId}/balances
  • Auth
    none required

Path parameters

withdrawalConfigIdstring required

The withdrawal config ID.

Query parameters

walletAddressstring required

Wallet address (holder pubkey) to read balances for.

hyperCoreLane'native' | 'eip3009'

HyperCore USDC withdrawals only. native (default) returns a hypercore prepared transaction. eip3009 opts into the hypercore_eip3009 route, which is used only when it's enabled for your account and the destination is routable; otherwise the withdrawal stays native. Send the same value on routes, balances and prepare.

HyperCore USDC only: pass the lane you will prepare with so maxWithdrawableAmount matches it. Defaults to native.

Response

Balances retrieved successfully.

walletAddressstring

Address balances were read against.

Changes