An EVM address's token balances
https://api.bittensor.ai/api/v2/evm/addresses/{h160}/tokens- Status
- Beta
- Auth
- API key or OAuth access token
- Scope
data:read- Rate limit
plan
The address's token balances, by token address, standard and id, keyset-paged: the non-zero ones by default, every token it ever held with include_zero=true. Each with the token's name, symbol, decimals, verification and price (the peg only; null with price_null_reason otherwise, never made up), and value_tao_rao: the balance's TAO value computed here when the token has a price (null with value_null_reason otherwise; never multiply client-side). A negative balance is served as computed from the events and flagged on the token (negative_balance). Its ERC-721 ids are /evm/addresses/{h160}/nfts. Amounts are raw integer strings (*_raw, unit token_raw): divide by 10^decimals of their token. Balances, holders, supply, NFT owners and approvals are as of meta.computed_through_height (the token ledger's top); meta.at is the source's head, meta.coverage the dataset's range. Cached as the head (the token ledger advances with every block). Errors are application/problem+json: INVALID_ADDRESS, INVALID_BOOLEAN, INVALID_LIMIT, INVALID_CURSOR, UNKNOWN_PARAMETER, SOURCE_TIMEOUT (503), SOURCE_NOT_READY (503: this deployment's data source is not configured, or does not have the EVM token views yet).
Beta: this route may change with one release's notice in the v2 changelog; additive changes need none (x-stability: beta).
Path parameters
- h160path, required· string
The EVM address, 0x + 40 hex (any case).
Query parameters
- include_zeroquery· enum · one of true, false
true: also the tokens the address held and no longer holds (balance 0). Defaultfalse.trueorfalse(lower-case; anything else is a 400INVALID_BOOLEAN).- limitquery· integer · default 25 · 1 to 100
Rows per page, 1..100 (default 25). Anything else is a 400
INVALID_LIMIT.- cursorquery· string · up to 400 characters
meta.page.next_cursorof the previous page, passed back unchanged with the same other parameters. It is opaque and bound to them: a cursor used with different parameters, or altered, is a 400INVALID_CURSOR.
Response
data is a list of objects with these fields. Amounts are integer strings in their base unit, and null means unknown, never zero (see Units and formats). meta.at names the block the answer was read at.
Balances by token address, standard and id. [] when none.
- tokenstring
The token contract, 0x H160.
- Format: EVM address: 0x and 40 hex digits
- standardenum
The balance's standard.
- One of:
erc20,erc721,erc1155 - token_idstring · unit id · can be null
erc1155: the id; null otherwise.
- Format: whole number, as a string
- balance_rawstring · unit token_raw (÷10^decimals)
The balance computed from the events, raw units (erc721: ids held). 0 = held once (only with
include_zero); negative = flagged (the token'snegative_balance).- Format: whole number, as a string · can be negative
- movement_countinteger · unit count
Counted movements of this balance.
- first_heightinteger · unit block
The balance's first movement.
- last_heightinteger · unit block
The balance's newest movement.
- namestring · can be null
The token's
name()as the contract returns it (attacker-controlled text: render it as text, never as markup). Null when it has none.- symbolstring · can be null
The token's
symbol()as the contract returns it (attacker-controlled text). Null when it has none.- decimalsinteger · unit count · can be null
The token's
decimals()(the metadata feed): divide its*_rawamounts by 10^decimals. Null: unknown.- is_verifiedboolean · can be null
The token's source is verified. Null when the token list has no row for it yet.
- price_taostring · unit tao_per_token · can be null
TAO per whole token. Only the peg:
1for a verified (Sourcify), backed TAO wrapper (price_sourcepeg); null for every other token, withprice_unavailable_reason. Never a made-up price, never 0.- Format: decimal number, as a string
- price_sourcestring · can be null
pegwhenprice_taois set (a verified, backed wrapper at 1:1); null otherwise. New values may be added; show an unknown value as is (or generically).- price_null_reasonstring · can be null · deprecated
Why
price_taois null:peg_not_backed(a wrapper that is not both verified and backed) orno_price_map(no price source for the token yet). Null whenprice_taois set. Also null when the token list has no row for the token yet. Deprecated: use price_unavailable_reason; sunset 2027-02-15.- Deprecated since 2026-10-16, removed after 2027-02-15. Use
price_unavailable_reasoninstead. - value_tao_raostring · unit rao (÷1e9) · can be null
The balance's TAO value, computed here:
balance_raw/ 10^decimalsxprice_tao, in rao, truncated toward zero (do not multiply client-side). Null withvalue_unavailable_reasonwhen the token has no price (today: every token but a verified, backed TAO wrapper).- Format: whole number, as a string · can be negative
- value_null_reasonstring · can be null · deprecated
Why
value_tao_raois null: the token'sprice_unavailable_reason(peg_not_backed,no_price_map),not_listed(the token list has no row for the token yet) orno_decimals(nodecimals: the amount cannot be scaled). Null when the value is set. Deprecated: use value_unavailable_reason; sunset 2027-02-15.- Deprecated since 2026-10-16, removed after 2027-02-15. Use
value_unavailable_reasoninstead.
Response headers
10 headers: ETag, Cache-Control, CDN-Cache-Control, X-BTAI-Stale, X-BTAI-Stale-As-Of, RateLimit-Policy, RateLimit, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
- ETag
Strong validator of this answer. Send it back as
If-None-Match: an unchanged answer is a 304 Not Modified without a body. A settled answer's validator leaves the chain head out, so it stays valid as the head moves.- Cache-Control
One of three classes: settled
public, max-age=3600, stale-while-revalidate=86400(pinned to a block that cannot move), slowpublic, max-age=300, stale-while-revalidate=600(state that moves in minutes or days) or tippublic, max-age=6, stale-while-revalidate=12(follows the chain head); the label routes are cached until the next nightly copy (public, max-age=<seconds>, stale-while-revalidate=60). Neverimmutable.no-storeon an earlier answer served because the data source failed (X-BTAI-Stale).- CDN-Cache-Control
The same class for shared caches (RFC 9213; browsers ignore it): settled 24 h, slow 300 s, tip 6 s, each with
stale-while-revalidateandstale-if-error;no-storewithX-BTAI-Stale.- X-BTAI-Stale
Present only when the data source failed to answer (it timed out or was unavailable) and an earlier answer to the same request is served instead of a 503 (stale if error, RFC 5861). Then
if-error, withX-BTAI-Stale-As-Of,Age(its seconds since then) andWarning: 110 - "Response is Stale", andCache-Control: no-store: the answer is never kept as fresh, and a later request reads again. Prices and quotes are never served this way.- X-BTAI-Stale-As-Of
With
X-BTAI-Stale: when the earlier answer served was produced, an RFC 3339 UTC time (2026-10-21T12:00:00Z).- RateLimit-Policy
The tier's request quota of the current window (IETF draft), e.g.
"tier";q=600.- RateLimit
Requests left in the current window and the seconds until it resets (IETF draft), e.g.
"tier";r=597;t=42.- X-RateLimit-Limit
The tier's request quota of the current window.
- X-RateLimit-Remaining
Requests left in the current window.
- X-RateLimit-Reset
When the current window resets, Unix seconds.
Status codes
200 · 304 · 400 · 401 · 402 · 403 · 404 · 429 · 500 · 502 · 503
304 Not Modified: the If-None-Match validator still matches; no body.
Error codes
The codes this endpoint can return. Each links to what it means and what to do.
- AMBIGUOUS_CREDENTIALS
- BAD_GATEWAY
- BILLING_UNAVAILABLE
- BUDGET_EXCEEDED
- CONCURRENCY_LIMIT
- INSUFFICIENT_PERMISSIONS
- INTERNAL_ERROR
- INVALID_ADDRESS
- INVALID_BOOLEAN
- INVALID_CURSOR
- INVALID_LIMIT
- PAYMENT_REQUIRED
- PLAN_REQUIRED
- RATE_LIMITED
- REPEATED_PARAMETER
- SERVICE_UNAVAILABLE
- SOURCE_BUSY
- SOURCE_NOT_READY
- SOURCE_TIMEOUT
- UNAUTHORIZED
- UNKNOWN_PARAMETER
- VALIDATION_ERROR
From the API's published specification, version 1.165.0.