Skip to main content
GET
List token balances

Headers

X-API-Key
string | null

Query Parameters

wallet_uuid
string<uuid> | null

Filter balances by wallet ID. The wallet ID can be retrieved by calling the List all wallets operation.

chain_id
string | null

Filter balances by chain ID (for example, SETH, BASE_ETH).

address
string | null

Filter balances by on-chain address.

token_id
string | null

Filter balances by token ID (for example, SETH, SETH_USDC).

force_refresh
boolean
default:false

When true and address is provided, force a fresh sync of balances from on-chain before returning results.

limit
integer
default:50

The maximum number of items to return. Range: [1, 200].

Required range: 1 <= x <= 200
after
string | null

A cursor for forward pagination. Pass the after value from a previous response to retrieve the next page.

before
string | null

A cursor for backward pagination. Pass the before value from a previous response to retrieve the preceding page.

offset
integer | null
deprecated

Deprecated. Use after/before cursors instead.

Required range: 0 <= x <= 9223372036854776000

Response

Successful Response

result
BalanceRead · object[]
required
success
boolean
default:true
suggestion
string
default:""
message
string
default:""
meta
PaginationMeta · object | null

Pagination metadata for list responses.

Supports both legacy offset-based and cursor-based pagination. Cursor fields (has_more, after, before) are populated for cursor-paginated endpoints. Legacy fields (offset, limit) are populated when the caller uses the deprecated offset parameter.