The stakers of a hotkey, on one subnet or many
https://api.bittensor.ai/api/v2/hotkeys/{hotkey}/stakers- Status
- Beta
- Auth
- API key or OAuth access token
- Scope
data:read- Rate limit
plan
The coldkeys staking on the hotkey: on one subnet (netuid), on a set (netuids), or, with neither, on every subnet where the hotkey has a pool.
Full description
The coldkeys staking on the hotkey: on one subnet (netuid), on a set (netuids), or, with neither, on every subnet where the hotkey has a pool. Rows are by netuid, then largest first (by alpha, then coldkey), each with its netuid: its alpha (its shares sized against the pool, floored), its part of the pool and its spot value in TAO, at the head of the state (meta.at). The owner's own stake is a row like any other. meta.netuids lists the subnets covered and meta.pools each one's pool (pool_alpha_rao) and spot price (price_tao, the price the values use). with_total=true adds meta.page.total (the stakes listed, above 0 alpha rao) and meta.page.nominators_with_shares (every coldkey holding a share, dust positions that round down to 0 alpha included): both are absent otherwise, because the exact total sizes every position of every listed subnet (seconds on a validator with stake on 120+ subnets, against ~0.25 s for a page). A hotkey with no stakers on the listed subnets (or never stored) answers []. Pages continue through meta.page.next_cursor (keyset (netuid, alpha, coldkey); null on the last page). Always the head (no at), so every page is tip-cached; a cursor minted on an older head still continues after its row, so stakes that changed in between can move across the page boundary. Accounts are SS58 (coldkey, meta.hotkey). Each row's account_kind says what the staker is from its bytes: a custody staker (such as the basket escrow) holds other accounts' funds, so leave it out of a ranking of stakers. mode=wallets (beta) answers one row per coldkey over the listed subnets instead (HotkeyStakersWalletRow: its total at spot, never null and a lower bound when a position is unpriced, its position count and subnets, its identity name, whether it is the hotkey's owner), by total descending then coldkey, keyset-paged, with meta.wallets_total and meta.positions_total over every page and no meta.pools; every subnet of a large validator is seconds cold. meta.mode says which shape is served. Errors are application/problem+json: INVALID_ADDRESS, INVALID_NETUID (outside 0..65535, more than 256, or netuid with netuids), INVALID_LIMIT, INVALID_CURSOR, INVALID_MODE (also with_total=true with mode=wallets), INVALID_INCLUDE, INVALID_OFFSET, UNKNOWN_PARAMETER, SOURCE_TIMEOUT (503), SOURCE_NOT_READY (503).
Beta: this route may change with one release's notice in the v2 changelog; additive changes need none (x-stability: beta).
Path parameters
- hotkeypath, required· string
The hotkey: SS58, or 0x + 64 hex.
Query parameters
- netuidquery· integer · 0 to 65535
One subnet. Not with
netuids(400INVALID_NETUID).- netuidsquery· string
Several subnets. A comma list (or the parameter repeated) of subnets, each 0..65535, as many as needed; duplicates are ignored. Anything else is a 400
INVALID_NETUID. With neither: every subnet of the hotkey.- with_totalquery· enum · one of true, false
true: addmeta.page.totalandmeta.page.nominators_with_shares(exact; sizes every position of every listed subnet). Defaultfalse: both absent.trueorfalse(lower-case; anything else is a 400INVALID_BOOLEAN).- limitquery· integer · default 50 · 1 to 1000
Page size, 1..1000 (default 50).
- cursorquery· string · up to 200 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.- includequery· string
namesadds the top-levelincluded.names: every distinct account on the page (accounts indataat 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 400INVALID_INCLUDE.- modequery· string
The row shape:
positions(the default: one row per (netuid, coldkey)) orwallets(one row per coldkey over the listed subnets, withmeta.wallets_total/meta.positions_total; not withwith_total=true). Anything else is a 400INVALID_MODE.- offsetquery· integer · at least 0
Page by number instead of by cursor (for tools such as the MCP server's): the page starting at this row, a multiple of
limit, at most 50 pages deep (offset/limit<= 50);meta.page.offsetechoes it andnext_cursorcontinues from it. The data source walks every page before it, so it is slower than a cursor the deeper it goes. Not withcursororwith_total=true. Anything else is a 400INVALID_OFFSET.
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.
mode=positions (the default): every row a HotkeyStaker, by netuid ascending, then alpha_rao descending, then coldkey. mode=wallets: every row a HotkeyStakersWalletRow, by total_spot_tao_rao descending, then coldkey (meta.mode says which). [] when the hotkey has no staker on the listed subnets (also for a hotkey the chain never stored).
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_INCLUDE
- INVALID_LIMIT
- INVALID_MODE
- INVALID_NETUID
- INVALID_OFFSET
- 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.