Skip to content
TAO$188.27
BTC0.002928
MCap$2.22B
Vol$86.25M

API reference / Basket funds

The holders of a basket fund

GET/api/v2/baskets/{hotkey}/holders
Status
Beta
Auth
API key or OAuth access token
Scope
data:read
Rate limit
plan

The holders of a validator's basket fund (its root stakers) at a UTC day end, by owed units descending: each one's root stake, owed and claimed units and that day's income (in units, and in TAO at the fund's NAV per unit; null on its first available day). meta.page.total counts them all; pages continue through meta.page.next_cursor (keyset; null on the last page), which is also how /baskets/{hotkey}?include=holders continues (call with day=<meta.day> and limit=<child_limit>). A page with day given is cached as settled; the default day moves with the newest available day. Errors are application/problem+json: INVALID_ADDRESS, INVALID_DAY, AT_OUT_OF_COVERAGE, INVALID_LIMIT, INVALID_CURSOR, INVALID_INCLUDE, BASKET_NOT_FOUND (404), NOT_READY (503), 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 validator's hotkey: SS58, or 0x + 64 hex.

Query parameters

dayquery· string

The UTC day, YYYY-MM-DD. Default: the latest available day.

limitquery· integer · default 50 · 1 to 1000

Page size, 1..1000 (default 50).

cursorquery· string · up to 200 characters

meta.page.next_cursor of 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 400 INVALID_CURSOR.

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.

Holders by owed_units descending, then coldkey.

coldkeystring

The holder (a root staker of the validator), SS58.

Format: SS58 address
account_kindobject

What the holder is, from its bytes.

4 fields in account_kind
kindstring

custody: a module account that holds other accounts' funds (the subnet pool accounts, the basket escrow, crowdloan funds, the limit-order intermediary), so its balance is not its own: leave it out of rankings of holders. protocol: any other module account. account: no module-account prefix; it may still be a multisig, a pure proxy or an EVM-mapped account (those cannot be told apart from the bytes). New values may be added; show an unknown value as is (or generically).

pallet_idstring · can be null

The module account's PalletId, the 8 bytes after the modl prefix as text (e.g. subtensr, bt/cloan). Null when kind is account.

subobject · can be null

The sub-account the bytes after the PalletId decode to. Null for a plain account, for a PalletId's base account, and for sub-account bytes that do not decode.

2 fields in sub
typestring

How the sub-account bytes decode: netuid (a subnet pool account's subnet, u16), index (a numbered sub-account such as a crowdloan fund's id, u32) or tag (8 printable bytes, e.g. beta/esc for the basket escrow). New values may be added; show an unknown value as is (or generically).

valueone of several

The decoded sub-account: an integer for netuid and index, a string for tag.

namestring · can be null

A readable name for the module account from a registry of known PalletIds (e.g. subnet pool account, basket escrow). Null when the registry does not know the account; never guessed.

root_stake_raostring · unit rao (÷1e9)

Its root stake on the validator, rao.

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

The fund units it is owed.

Format: whole number, as a string
claimed_unitsstring · unit shares

The units it has claimed.

Format: whole number, as a string
income_unitsstring · unit shares · can be null

The day's basket-unit income. Null on the holder's first available day.

Format: whole number, as a string
income_tao_raostring · unit rao (÷1e9) · can be null

income_units valued at the fund's NAV per unit (pre-claim / close anchors), floored, rao. Null with income_units.

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.