Accounts ranked by TAO held (total, free or staked) at a UTC day's close
https://api.bittensor.ai/api/v2/accounts/rich-list- Status
- Beta
- Auth
- API key or OAuth access token
- Scope
data:read- Rate limit
plan
The rich list: every account with a balance above 0 in sort, ranked at the close of a UTC day (day, default the newest available day), largest first, ties by account bytes ascending.
Full description
The rich list: every account with a balance above 0 in sort, ranked at the close of a UTC day (day, default the newest available day), largest first, ties by account bytes ascending. sort: total (free + reserved + staked, the default), free or staked. Per account: free, reserved, staked and total TAO (rao), the number of subnets it holds alpha on, and whether the staked value (so the total) is a lower bound (a holding with no close price that day). Free and reserved are the account's System.Account balance at the day's close (carried forward from its last change). Staked is its alpha holdings as a coldkey on every subnet, root included, valued in TAO at each pool's close price that day. Unclaimed root dividends and liquidity-provider positions are not in these balances. Protocol accounts are pallet / module accounts (their 32 bytes start with modl): subnet accounts, escrows, the treasury. They hold TAO for the protocol, not for a holder, and are left out by default (exclude_protocol=true). Paged by cursor (meta.page.next_cursor), limit rows a page (1..100, default 50); ranks continue across pages, and every page of one cursor chain reads the first page's day. Read from the analytics store only: it computes each UTC day after it closes, so the newest day is meta.through_day. A day more than 6 hours overdue (at most 36) is still served, labelled by meta.through_day, with the response headers X-BTAI-Data-Through: <YYYY-MM-DD> and X-BTAI-Overdue-S: <seconds> (cached as slow); a store more than 36 hours overdue is a 503 SOURCE_NOT_READY with Retry-After, as is one still computing the day. meta.sources names the store. Where this deployment does not serve the rich list the route is a 503 SOURCE_NOT_READY. A pinned day (day, or a cursor) is cached as settled, the newest day as slow. Errors are application/problem+json: INVALID_DAY (not a date, or outside the available days), INVALID_SORT, INVALID_BOOLEAN, INVALID_LIMIT, INVALID_CURSOR, UNKNOWN_PARAMETER, SOURCE_TIMEOUT (503), SOURCE_NOT_READY (503), SERVICE_UNAVAILABLE (503), BAD_GATEWAY (502: the store's answer broke its contract).
Beta: this route may change with one release's notice in the v2 changelog; additive changes need none (x-stability: beta).
Query parameters
- dayquery· string
The UTC day ranked,
YYYY-MM-DD, at its close (default: the newest available day,meta.through_day). Not a date, or outsidemeta.coverage_from_day..meta.through_day: a 400INVALID_DAY. With a cursor, the cursor's day (another day is a 400INVALID_CURSOR).- sortquery· enum · one of total, free, staked · default total
The balance ranked:
total(free + reserved + staked, the default),freeorstaked. Anything else is a 400INVALID_SORT.- exclude_protocolquery· enum · one of true, false · default true
true(the default): leave protocol accounts (pallet / module accounts: subnet accounts, escrows, the treasury) out.false: rank and count them too. Lower-case; anything else is a 400INVALID_BOOLEAN.- limitquery· integer · default 50 · 1 to 100
Rows per page, 1..100 (default 50). Anything else is a 400
INVALID_LIMIT.- cursorquery· string · up to 200 characters
meta.page.next_cursorof the previous page, unchanged, with the samesortandexclude_protocol. Anything else 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.
The page's accounts, by value descending then account ascending; only accounts with a value above 0 (holders_nonzero on the holder thresholds also counts accounts that hold units worth 0). [] past the last one.
- rankinteger · unit count
1 = the largest value in
meta.sort(ties by account bytes ascending), over the scope asked (meta.exclude_protocol). Contiguous across pages.- accountobject
The account, in both encodings.
2 fields in account
- ss58string
The account, SS58 (prefix 42).
- Format: SS58 address
- hexstring
The same 32-byte account id, 0x + 64 lower-case hex (the public key).
- Format: 32-byte hex: 0x and 64 hex digits
- account_kindstring
wallet: an ordinary account, or an EVM mirror not yet recognised.protocol: a pallet / module account (modlprefix: subnet accounts, escrows, the treasury), served only withexclude_protocol=false.evm_mirror: the 32-byte mirror account of a KNOWN EVM (H160) address. The mirror is a one-way hash of the H160, so only H160s the chain has shown are recognised:evm_mirroris a lower bound, and a mirror whose H160 is unseen is served aswallet. New values may be added; show an unknown value as is (or generically).- free_raostring · unit rao (÷1e9)
Free balance at the day's close, rao.
- Format: whole number, as a string · on chain: u64
- reserved_raostring · unit rao (÷1e9)
Reserved balance at the day's close, rao.
- Format: whole number, as a string · on chain: u64
- staked_raostring · unit rao (÷1e9)
The account's alpha holdings as a coldkey on every subnet (root included), in TAO at each pool's close price that day, rao. Unclaimed root dividends and liquidity-provider positions are not included.
- Format: whole number, as a string · on chain: u64
- total_raostring · unit rao (÷1e9)
free_rao+reserved_rao+staked_rao, rao (exact unlesstotal_is_lower_bound).- Format: whole number, as a string · on chain: u64
- staked_is_lower_boundboolean
True when a holding had no close price that day: it is left out of
staked_rao, which is then a lower bound.- total_is_lower_boundboolean
True when
total_raois a lower bound (it carries a lower-boundstaked_rao).- subnetsinteger · unit count
Subnet holdings (netuid lives) with alpha above 0 that day.
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_BOOLEAN
- INVALID_CURSOR
- INVALID_DAY
- INVALID_LIMIT
- INVALID_SORT
- PAYMENT_REQUIRED
- PLAN_LIMIT_EXCEEDED
- 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.