Skip to main content
GET
Get an address balance
Use the playground below to try this endpoint directly, or review the OpenAPI details in the right panel.

Query parameters by address type

Both transfer_type and value_type are required.

Plaid-linked bank balances

Response
  • Brale uses Plaid’s available balance when Plaid supplies it. Otherwise, Brale uses the current balance.
  • Successful reads may be cached for up to 30 seconds.
  • The balance is a point-in-time snapshot. It does not guarantee that an ACH debit will settle.
  • Brale never returns the full bank account number. account_number is masked.
  • Only Plaid-linked USD bank addresses support balance lookup. Bank addresses created through Direct bank entry do not.

Errors

service_unavailable does not mean the balance is zero or insufficient.

Authorizations

Authorization
string
header
required

Use the Bearer token returned from the Auth endpoint via OAuth2 client_credentials flow. Include the token in the "Authorization: Bearer " header.

Path Parameters

account_id
string<ksuid>
required

The ID of the account

Pattern: ^[a-zA-Z0-9]{26}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

address_id
string<ksuid>
required

The ID of the address

Pattern: ^[a-zA-Z0-9]{26}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

Query Parameters

transfer_type
string
required

Blockchain network for wallets (for example, solana, base, ethereum), or ach_debit for a Plaid-linked bank.

value_type
string
required

Token ticker for wallets (for example, SBC, USDC), or USD for a Plaid-linked bank.

Response

The address details and balance info

Balance of one token on one chain for a custodial wallet, or the USD balance of a Plaid-linked bank address.

address
AddressReference · object
required
balance
Amount · object
required

Monetary value with explicit currency

transfer_type
string
required

Blockchain network for wallets (for example, solana or base), or ach_debit for a Plaid-linked bank.

Example:

"solana"

value_type
string
required

Token ticker for wallets (for example, SBC), or USD for a Plaid-linked bank.

Example:

"SBC"