Wallet Get
Read the addresses and balances of a user's wallet across every supported network.
POST /api/wallet/get
Returns wallet addresses and the latest known balances. Pass sync: true to refresh balances before a transfer or payout.
Request
Also available as GET /api/wallet, with the same parameters in the query string.
curl --request POST \
--url https://api.hodle.com.br/api/wallet/get \
--header "Authorization: Bearer $API_KEY" \
--header "Content-Type: application/json" \
--data '{ "sync": false }'const res = await fetch('https://api.hodle.com.br/api/wallet/get', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.HODLE_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ sync: false }),
})
const data = await res.json()import os, requests
res = requests.post(
"https://api.hodle.com.br/api/wallet/get",
headers={
"Authorization": f"Bearer {os.environ['HODLE_API_KEY']}",
"Content-Type": "application/json",
},
json={"sync": False},
)
data = res.json()Parameters
| Field | Type | Required | Description |
|---|---|---|---|
walletId | string | No | Wallet (data.id from /api/wallet/create) belonging to the selected owner/subaccount. Omit for default selection per network. |
subAccountId | string | No | Owned subaccount containing the wallet. Omit for the API key owner’s own wallet. |
sync | boolean | No | Refresh balances before returning. Default false. |
A read with walletId also returns data.walletId. See Wallet Keys for creating a protected wallet and selecting it in operations.
Response
{
"success": true,
"data": {
"subAccountId": "5b9f1a83b6b7c2b001f3c9e21",
"addresses": {
"polygon": "0x4b1f...c9a2",
"base": "0x4b1f...c9a2",
"bnb": "0x4b1f...c9a2",
"tron": "TQHvP...kZ8",
"solana": "9xQeW...VFin",
"spark": "spark1pgss92n427yh3ghz5dq0j93ph3p9lrmhy7enrus02uusmd6ktlx23t88en8f8j",
"sparkLightning": "you@hodle.com.br"
},
"balances": [
{ "network": "polygon", "asset": "USDT", "amount": "182.45" },
{ "network": "polygon", "asset": "USDC", "amount": "0.00" },
{ "network": "polygon", "asset": "BRLA", "amount": "2.02" },
{ "network": "base", "asset": "USDC", "amount": "0.00" },
{ "network": "base", "asset": "BRLA", "amount": "0.00" },
{ "network": "base", "asset": "BRS", "amount": "0.00" },
{ "network": "bnb", "asset": "USDT", "amount": "0.00" },
{ "network": "tron", "asset": "USDT", "amount": "0.00" },
{ "network": "solana", "asset": "USDT", "amount": "0.00" },
{ "network": "solana", "asset": "USDC", "amount": "12.34" },
{ "network": "solana", "asset": "BRS", "amount": "0.00" }
],
"syncedAt": "2026-05-09T22:14:00.000Z"
}
}| Field | Type | Description |
|---|---|---|
addresses | object | Receive addresses for the wallet's available networks. |
balances | array | Available balances by network and asset, as decimal strings. Rows may be absent before a successful balance read. |
syncedAt | string | Latest balance-read timestamp in ISO-8601 format; current time if no read is available. |
Getting notified when crypto arrives
Customers can send the asset directly to one of these addresses from any external wallet. To
learn when it lands without polling this endpoint, subscribe to the
DEPOSIT_ONCHAIN_RECEIVED webhook: it covers USDC,
USDT and BRLA on polygon, USDC and BRLA on base, and USDC, USDT and BRS on solana, for
the wallets of your account and of every sub-account.
Networks and assets
| Network | Asset(s) | Notes |
|---|---|---|
polygon | USDT, USDC, BRLA | Gas sponsored. |
base | USDC, BRLA, BRS | Gas sponsored. BRS enabled per account (ask support). |
bnb | USDT | Enabled per approved account (ask support). Address and balance omitted otherwise. |
tron | USDT | Network fees sponsored. |
solana | USDT, USDC, BRS | Network fees sponsored. BRS enabled per account (ask support). Requires a Solana address. |
stellar | USDC, XLM | Requires a Stellar wallet. |
liquid | LBTC, DEPIX | Requires a Liquid wallet. |
spark | — | addresses.spark receives BTC and DePix; addresses.sparkLightning is the wallet's Lightning address. Available after the owner first unlocks the wallet. Spark balance rows are not returned. |
Errors
| Status | When |
|---|---|
400 | Invalid parameters, including a malformed walletId. |
401 | Missing or invalid API key. |
404 | Wallet or subaccount not found, removed or outside your account. Create a wallet if it has not been provisioned. |
{ "success": false, "error": "Wallet not found" }A subaccount you own that has no wallet yet answers 404 with errorCode: "SUBACCOUNT_WALLET_NOT_PROVISIONED". Subaccount wallets are created when its KYC is approved: wait for the KYC_APPROVED webhook (or GET /api/kyc?subAccountId=... with status: APPROVED) before reading it. An unknown subaccount keeps "Subaccount not found for this platform", without errorCode.
{
"success": false,
"error": "Sub-account has no wallet yet: wallets are created when its KYC is approved",
"errorCode": "SUBACCOUNT_WALLET_NOT_PROVISIONED"
}