Skip to main content
GET
Get current token balances of an address

Authorizations

X-API-KEY
string
header
required

Authorization method required to allow user to access the api endpoints.

Query Parameters

network
string
required

Network of Address

Example:

"ethereum"

address
string
required

Address to search

Example:

"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"

network_type
string
required

network type: evm, solana, cosmos, etc.

Example:

"evm"

token_contracts
string
required

Comma separated list of token contract addresses (max 30).

Example:

"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"

workspace_id
string

Your own workspace id, to filter this address's balances by your workspace's token whitelist. Must equal the workspace of the API key making the request (403 otherwise). Omit for the unfiltered response.

show_all
boolean
default:false

Restores the unfiltered response, ignoring the workspace token whitelist. Only meaningful alongside workspace_id.

Response

Token balances of the given address, plus lookup status.

balances
object
required

Always present; never null. An empty set (both arrays empty) when lookup_status is unavailable or unsupported, since there is no genuine answer to serve. Populated (fully, on ok, or partly, on partial) otherwise. See ADR-0013: the lookup outcome always travels on lookup_status/reason rather than by changing the shape of this field.

lookup_status
enum<string>
required

Outcome of this balance lookup. ok: fully resolved. partial: the native balance leg failed but token balances resolved and are included. unavailable: the lookup failed entirely; retry may succeed. unsupported: this chain has no readable balance source, evaluated before any lookup was attempted; retrying will not help. Always present, including on a fully successful lookup.

Available options:
ok,
unsupported,
unavailable,
partial
Example:

"ok"

reason
object | null
required

Why the lookup did not return ok. Always present as an explicit null on ok/unsupported; populated on partial/unavailable.

hidden_count
number
required

RNG-5741: count of tokens the workspace token whitelist removed from balances above. 0 both when nothing was filtered and when lookup_status is not ok/partial (no genuine answer to filter). Always 0 when show_all was requested or no workspace_id was given. Always present.

Example:

0

Last modified on November 9, 2026