Skip to content
TAO$188.40
BTC0.00293
MCap$2.21B
Vol$86.07M

API reference / Leaderboard

Staking coldkeys ranked by stake or rewards

GET/api/v2/leaderboard
Status
Beta
Auth
API key or OAuth access token
Scope
data:read
Rate limit
plan

Every staking coldkey ranked at a UTC day end, by stake (the priced positions at the day's close) or by rewards (rewards_30d_net_tao_rao), offset-paged (offset, limit; meta.page.total_count counts every ranked coldkey).

Full description

Every staking coldkey ranked at a UTC day end, by stake (the priced positions at the day's close) or by rewards (rewards_30d_net_tao_rao), offset-paged (offset, limit; meta.page.total_count counts every ranked coldkey). Each row has both ranks, the stake and its USD, positions and subnets (with the unpriced count), the rewards over the window by role and the pool appreciation. rewards_30d_net_tao_rao is income only (miner incentive incl. auto-stake, validator take, owner cut, root take, each day's alpha at that day's close): pool growth is appreciation_30d_tao_rao, never added in. The window is 30 days nominally: meta.window.income_days (and growth_days) say how many days were actually valued, fewer than 30 while the series is young (6 on 2026-10-03), so the 30-day figures cover only those days until then. USD at meta.tao_usd (the day end's price). include=names adds the coldkeys' names. An explicit day is cached as settled. Errors are application/problem+json: INVALID_DAY, AT_OUT_OF_COVERAGE, INVALID_SORT, INVALID_LIMIT, INVALID_OFFSET, INVALID_INCLUDE, NOT_READY (503), UNKNOWN_PARAMETER, SOURCE_TIMEOUT (503), SOURCE_NOT_READY (503). meta.final_through_day is the last day whose ranking is final: a day at or before it never changes again (but by an announced rerun), the key to cache closed days by; null on an older data version's answer.

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, YYYY-MM-DD. Default: the latest available day.

sortquery· enum · one of stake, rewards · default stake

stake (the default) or rewards (30-day income); rank follows it. Anything else is a 400 INVALID_SORT.

limitquery· integer · default 100 · 1 to 500

Page size, 1..500 (default 100; this route's cap, above it is a 400 INVALID_LIMIT).

offsetquery· integer · default 0 · 0 to 10000000

Rows skipped: the page holds ranks offset + 1..offset + limit (default 0). Anything else is a 400 INVALID_OFFSET.

includequery· string

names adds the top-level included.names: every distinct account on the page (accounts in data at any depth, event args included) keyed by its SS58 address, each {identity: {name} | null, label: {text, source, confidence, verified, inferred, as_of} | null}; the on-chain identity and the off-chain label are kept apart, and a label is never a chain fact. A missing key means 'not looked up', null means 'none'. At most 500 accounts (included.names_truncated). Still one call (the data source sideloads them in the same statement); an answer with names is cached as a head answer (names follow the head). Anything else is a 400 INVALID_INCLUDE.

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 coldkeys, by rank ascending.

rankinteger · unit count

The rank in this page's sort (rank_stake or rank_income).

rank_stakeinteger · unit count

The rank by stake_spot_tao_rao (1 = largest).

rank_incomeinteger · unit count

The rank by rewards_30d_net_tao_rao (1 = largest).

coldkeystring

The coldkey, SS58 (prefix 42).

Format: SS58 address
stake_spot_tao_raostring · unit rao (÷1e9)

The priced positions at the day's close, rao of TAO (positions_unpriced counts the rest).

Format: whole number, as a string · on chain: u64
stake_spot_usdstring · unit usd · 6 decimals · can be null

stake_spot_tao_rao in USD at meta.tao_usd, 6 decimals. Null without a TAO/USD price.

Format: decimal number, as a string
positionsinteger · unit count

Stake positions held at the day end.

subnetsinteger · unit count

Subnets staked on at the day end.

positions_unpricedinteger · unit count

Positions on subnets whose closing price was unknown: not in stake_spot_tao_rao.

rewards_30d_net_tao_raostring · unit rao (÷1e9)

Income only over the window (meta.window): miner incentive (auto-stake included), validator take, owner cut, root take and the basket flush credit, each day's alpha at that day's closing pool price, rao of TAO. Pool growth is not in it (it is appreciation_30d_tao_rao, never added in). Over meta.window.income_days days, fewer than 30 while the series is young.

Format: whole number, as a string · on chain: u64
rewards_30d_net_usdstring · unit usd · 6 decimals · can be null

rewards_30d_net_tao_rao in USD at meta.tao_usd (today's price, not each day's), 6 decimals. Null without a TAO/USD price.

Format: decimal number, as a string
rewards_by_role_tao_raoobject

rewards_30d_net_tao_rao by component, rao of TAO, summing to it: miner_incentive, validator_take, owner_cut, root_take, ... (an open vocabulary: clients must accept components not documented yet). {} when there is no income.

appreciation_30d_tao_raostring · unit rao (÷1e9)

Pool growth on the positions over the window (the nominator return: dividends paid into the pools, net of take), at each day's close, rao of TAO, over meta.window.growth_days days. Never part of the rewards.

Format: whole number, as a string · on chain: u64

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), slow public, max-age=300, stale-while-revalidate=600 (state that moves in minutes or days) or tip public, 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). Never immutable. no-store on 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-revalidate and stale-if-error; no-store with X-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, with X-BTAI-Stale-As-Of, Age (its seconds since then) and Warning: 110 - "Response is Stale", and Cache-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.

From the API's published specification, version 1.165.0.