Skip to main content
GET
Get Withdrawal Balances
For HyperCore configs, show maxWithdrawableAmount as the limit and pass the same hyperCoreLane you’ll send to prepare, so the reserve matches the lane (see Choose the lane).

Path Parameters

withdrawalConfigId
string
required

The withdrawal config ID.

Query Parameters

walletAddress
string
required

Wallet address (holder pubkey) to read balances for.

hyperCoreLane
enum<string>

HyperCore USDC only: pass the lane you will prepare with so maxWithdrawableAmount matches it. Defaults to native. 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.

Available options:
native,
eip3009

Response

Balances retrieved successfully.

walletAddress
string

Address balances were read against.

balances
object[]