Skip to content
TAO$188.21
BTC0.002927
MCap$2.22B
Vol$86.25M

API reference / Basket funds

Every basket fund at a day end

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

Every validator's v441 basket fund at a UTC day end, largest first.

Full description

Every validator's v441 basket fund at a UTC day end, largest first: units outstanding, what the holders are owed, the holder count and the realizable NAV, plus each fund's pricing (the chain's fund pricing: provisional is a flag, never a 0; display and stake prices, the staker TWR, the bag and stake index levels and the vs-index ratios, each null with a reason code), returns (7- and 30-day NAV-per-unit returns and staker TWR, each refused window with its reason) and staking (the validator's nominator APY, the APY and APR at the reference stake, the swap round-trip / entry / exit cost and the breakeven days, blended over every pool, root included; a staked pool lacking a value nulls the whole figure, with unavailable_reason; staking.subnet_only gives the same figures over the subnet pools only, netuid != 0, null on an older answer). apy_at_reference_stake_ratio holds the dividend constant as the reference stake joins, so it understates; breakeven_days divides exactly the round_trip_cost_ratio and reference_apr_ratio served beside it (null with no_yield when that APR is not above 0). Also each fund's 7-day NAV-per-unit sparkline (sparkline_7d_nav_per_unit), swap count and volume (trades_7d, volume_7d_tao_rao) and meta.controls (the runtime's basket constants); each fund's holding_count (the subnets it holds alpha in); each fund's root_stake (option A) and fund (option B, with its composition and trading), two blocks never combined (no rate across options), stored once per accrual day with their own as_of_*, its subnet_stake_spot_tao_rao and staked_subnet_count (a value and a count, never a subnet rate), and order / dir (meta.page.order / dir); each fund's n_stakers_with_stake (the stakers with root stake > 0 at the day end; n_stakers also counts those with a claim record and no stake left) and include=validator (each fund hotkey's validator figures at the state head, for every fund of the page). min_nav_tao_rao keeps the funds whose NAV is at least a value, view=summary leaves root_stake and fund out of every row, and meta.totals sums the funds every filter keeps (count, NAV, unvalued count) over all pages (null on an older data version's answer). Keyset-paged by meta.page.next_cursor; meta.page.total counts every fund that day. GET /baskets/{hotkey} is one fund with its series and holders. An explicit at is cached as settled, unless a fund carries head state or staking blocks (the latest accrual day's, whatever day is served); without at, the latest day's answer is cached 5 minutes. Errors are application/problem+json: INVALID_AT, AT_OUT_OF_COVERAGE, INVALID_SORT, INVALID_ORDER, INVALID_DIR, INVALID_LIMIT, INVALID_CURSOR, INVALID_INCLUDE, INVALID_AMOUNT, INVALID_FIELDS, 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).

Query parameters

atquery· string

The UTC day end to read: a day (YYYY-MM-DD) or a block height (the latest available day end at or below it). Default: the latest available day. Outside the available days: 400 AT_OUT_OF_COVERAGE; block 0 (the genesis block, which has no timestamp) and anything else: 400 INVALID_AT.

Format: a block height or a date, YYYY-MM-DD
sortquery· enum · one of shares, nav, n_stakers, root_apy_7d, root_apy_30d, holder_return_7d, holder_return_30d, staker_twr_30d, fund_nav_realizable, root_stake, take, trades_7d, age

The order's key. shares (units outstanding, the default), nav (the realizable NAV, as fund_nav_realizable) and n_stakers sort descending only (order=asc with them is a 400 INVALID_ORDER, except nav, which sorts as fund_nav_realizable). Descending by default: root_apy_7d / root_apy_30d (option A's holder-true accrual, root_stake.apy_*), holder_return_7d / holder_return_30d (option B's, fund.holder_return_*), staker_twr_30d (root_stake.staker_twr_30d), fund_nav_realizable (the realizable NAV), root_stake (root_stake.root_stake_tao_rao) and trades_7d; ascending by default: take (root_stake.take_ratio) and age (fund.first_block, the oldest first). Each sorts one option's figure, never a blend. A fund without the key's value comes last in either direction, keeping its reason; ties by the hotkey's bytes, ascending. Anything else is a 400 INVALID_SORT.

limitquery· integer · default 50 · 1 to 500

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

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

validator, names (a comma list; repeatable). validator adds each fund row's validator: its hotkey's validator figures at the state head (stake at spot and its root / subnet split, nominator positions and wallets, the 30-day realized emission at spot, first / last seen height, permit and root UID flags, the validator and UID subnet counts, the take; also the owner's own stake at spot, the valued nominator positions and wallets and the 7- / 30-day root APY RatioFigures, as GET /validators defines them, null on an older data version's answer), read from stored sets refreshed every ~20 blocks (heights in meta.validator; a fund neither set holds yet is null and counted in meta.validator.missing) (head state). 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.

orderquery· enum · one of asc, desc

The direction, asc or desc (default: the key's). The old spelling order=<key> (a sort key, which then overrides sort) is still accepted. Anything else is a 400 INVALID_ORDER.

min_nav_tao_raoquery· string · up to 30 characters

Only the funds whose nav_tao_rao is at least this value: an integer count of rao (1 TAO = 10^9 rao, so 1000000000 is 1 TAO), inclusive (nav_tao_rao >= value), >= 0. A fund without a NAV (nav_tao_rao null) is left out whenever it is given (so 0 keeps every valued fund). meta.page.total and meta.totals count the funds it keeps. Not a non-negative integer: a 400 INVALID_AMOUNT.

Format: whole number, as a string
viewquery· enum · one of full, summary

The row shape: full (the default) or summary, every row without root_stake and fund (absent, not null; every other member as in full), a smaller and faster answer for a list that does not show the two options. Echoed as meta.view. Anything else is a 400 INVALID_FIELDS.

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 funds, by meta.page.order in meta.page.dir, else by meta.page.sort descending (a fund without the value last in either direction), then hotkey.

hotkeystring

The validator running the fund, SS58 (prefix 42).

Format: SS58 address
account_kindobject

What the hotkey 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.

daystring (date)

The UTC day.

Format: date, YYYY-MM-DD
heightinteger · unit block

The day's last block.

shares_unitsstring · unit shares · can be null

BasketShares: the fund's units outstanding. Null when not readable.

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

The units owed to the holders, summed (each holder's capped at the fund's units, as the runtime caps it).

Format: whole number, as a string
sum_owed_sourcestring

Always derived (an opaque identifier): a computed sum, not a chain value. New values may be added; show an unknown value as is (or generically).

unowed_shares_unitsstring · unit shares · can be null

shares_units - sum_owed_units: units no holder is owed. May be negative by a few units (rate accrual dust; never clamped). Null with shares_units.

Format: whole number, as a string · can be negative
unowed_shares_sourcestring

Always derived (an opaque identifier): a computed figure, not a chain value. New values may be added; show an unknown value as is (or generically).

n_stakersinteger · unit count

The fund's stakers at the day end: the (fund hotkey, coldkey) pairs holding a root share key (Alpha / AlphaV2 on netuid 0) OR a BasketClaimed record, the fund escrow excluded. It includes stakers whose root stake is now 0 with a claim record; dust is not excluded. The stakers with stake are n_stakers_with_stake.

n_stakers_with_stakeinteger · unit count · can be null

The stakers with root stake > 0 at the day end (the count usually shown as "Stakers"): a subset of n_stakers (at most it, checked); dust not excluded. Null on a day from before this figure was recorded, and on an older data version's answer.

nav_tao_raostring · unit rao (÷1e9) · can be null

The runtime's realizable (slippage-aware) NAV at the day's close, rao. Null when the runtime call was not available.

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

The chain's fund pricing at the day end (BetaBaseline / BasketTwr / BetaIndexSnapshot and the runtime's spot NAV): the same values BetaBasketRuntimeApi.get_beta_pricing returns.

13 fields in pricing
provisionalboolean · can be null

True when the fund has no BetaBaseline: it prices at the live index until its next mint stamps it, and display_price, stake_price, staker_twr and both vs-index ratios are null. A flag, never a 0: key on it, not on a zero price. Null while the day's pricing isn't available yet (vs_index_unavailable_reason is then not_ready and every figure is null): unknown, not provisional.

first_blockinteger · unit block · can be null

The stamp block: where the display line begins. Null while provisional.

spot_pricestring · unit rao_per_share · 12 decimals · can be null

The spot NAV per share (raw): spot NAV / units outstanding, rao per unit, 12 decimals. Null without units or a NAV.

Format: decimal number, as a string · can be negative
display_pricestring · unit coefficient · 12 decimals · can be null

spot_price / BetaBaseline.price_divisor: the fund's price spliced onto the bag index at the stamp (a level), 12 decimals. Null while provisional.

Format: decimal number, as a string · can be negative
stake_pricestring · unit coefficient · 12 decimals · can be null

tr_splice x BasketTwr: the staker's price line (a level), 12 decimals. Null while provisional or staker_twr_defaulted.

Format: decimal number, as a string · can be negative
staker_twrstring · unit coefficient · 12 decimals · can be null

BasketTwr: the staker total-return level since the life's start (not annualised), 12 decimals. Null while provisional or staker_twr_defaulted.

Format: decimal number, as a string · can be negative
staker_twr_defaultedboolean · can be null

True when there is no BasketTwr key (no dividend minted in this life): staker_twr, stake_price and vs_index_stake_ratio are null. Null while the day's pricing isn't available yet (as provisional).

bag_indexstring · unit coefficient · 12 decimals · can be null

BetaIndexSnapshot's bag index level at the day end, 12 decimals. Null before the first snapshot.

Format: decimal number, as a string · can be negative
stake_indexstring · unit coefficient · 12 decimals · can be null

BetaIndexSnapshot's stake index level at the day end, 12 decimals. Null before the first snapshot.

Format: decimal number, as a string · can be negative
index_blockinteger · unit block · can be null

The published index snapshot's block. Null without one.

vs_index_bag_ratiostring · unit ratio · 12 decimals · can be null

display_price / bag_index - 1 (the quotient at 12 decimals): the cumulative excess over the bag index since the stamp, a signed ratio. A spot-marked numerator against a realizable-marked index, so a thin pool reads its spot-realizable gap as excess. Null with vs_index_unavailable_reason.

Format: decimal number, as a string · can be negative
vs_index_stake_ratiostring · unit ratio · 12 decimals · can be null

stake_price / stake_index - 1, a signed ratio, 12 decimals. Null with vs_index_unavailable_reason (or staker_twr_defaulted).

Format: decimal number, as a string · can be negative
vs_index_unavailable_reasonstring · can be null

Why both vs-index ratios are null; null when they are given. Precedence provisional > fund_reset (a reset on any anchor since the stamp, the current day's claim anchors included) > dust_fund (now: units < 1e9 or realizable NAV < 1 TAO); not_ready while the day's pricing isn't available yet (provisional and staker_twr_defaulted are null then). insufficient_history is the same case on an older data version's answer. New values may be added; treat unknown values as unavailable.

returnsobject

The fund's 7- and 30-day NAV-per-unit returns and the staker's TWR over the same windows.

8 fields in returns
return_7d_ratiostring · unit ratio · 12 decimals · can be null

The realizable NAV per unit at the served day end over the one 7 day ends before, minus 1: a signed ratio, 12 decimals. Null with return_7d_unavailable_reason.

Format: decimal number, as a string · can be negative
return_7d_unavailable_reasonstring · can be null

Why return_7d_ratio is null: any refused day refuses the window, precedence fund_reset (units drained through 1e9, or a day's NAV-per-unit ratio above 2 or under 0.5) > share_collapse (close units under half the open's) > dust_fund (units under 1e9 or NAV under 1 TAO) > insufficient_history (a missing day, or the window starts before the available series). Null when given. New values may be added; treat unknown values as unavailable.

staker_twr_7d_ratiostring · unit ratio · 12 decimals · can be null

BasketTwr(day) / BasketTwr(day - 7) - 1: the staker's 7-day total return, a signed ratio, 12 decimals. Null with staker_twr_7d_unavailable_reason.

Format: decimal number, as a string · can be negative
staker_twr_7d_unavailable_reasonstring · can be null

insufficient_history (the life changed, or a side has no BasketTwr) exactly when staker_twr_7d_ratio is null; null otherwise. New values may be added; treat unknown values as unavailable.

return_30d_ratiostring · unit ratio · 12 decimals · can be null

The same over the 30 day ends ending at the served day: a signed ratio, 12 decimals. Null with return_30d_unavailable_reason.

Format: decimal number, as a string · can be negative
return_30d_unavailable_reasonstring · can be null

Why return_30d_ratio is null, as return_7d_unavailable_reason. Null when given. Known values: fund_reset, share_collapse, dust_fund, insufficient_history. New values may be added; treat unknown values as unavailable.

staker_twr_30d_ratiostring · unit ratio · 12 decimals · can be null

BasketTwr(day) / BasketTwr(day - 30) - 1, a signed ratio, 12 decimals. Null with staker_twr_30d_unavailable_reason.

Format: decimal number, as a string · can be negative
staker_twr_30d_unavailable_reasonstring · can be null

As staker_twr_7d_unavailable_reason, for 30 days. Known values: insufficient_history. New values may be added; treat unknown values as unavailable.

stakingobject

The validator's staking figures at the served day, blended over its pools (subnets AND root) by each pool's TAO value at its window open; each pool annualised over its own day count. Any staked pool without a value makes a figure null (no partial blend), with unavailable_reason. The top-level figures cover every pool, root included; subnet_only the subnet pools only (netuid != 0).

13 fields in staking
poolsinteger · unit count · can be null

The validator's staked pools blended: every pool, root included (subnets and root).

pools_refusedinteger · unit count · can be null

Pools whose per-share return was refused (a share restart, or no history).

window_daysobject

The pools' window lengths.

3 fields in window_days
mininteger · unit days · can be null

The shortest pool window, days. Null without pools.

maxinteger · unit days · can be null

The longest pool window, days. Null without pools.

targetinteger · unit days

Always 7: 7 complete UTC days, fewer for a younger pool (or a short series), 1 with a material childkey take (> 1 %).

reference_stake_tao_raostring · unit rao (÷1e9) · can be null

The day's reference stake, rao (the 30-day median real stake-add; 10 TAO fallback): what the reference figures and the costs are for. Null before the first reference day.

Format: decimal number, as a string · can be negative
nominator_apy_ratiostring · unit ratio · 8 decimals · can be null

Σ w ((1 + y)^(365 / days) - 1) / Σ w: y = the pool's per-share return (TotalHotkeyAlpha / shares) over its window, net of the validator's take, alpha-denominated (the price move is not included); w = the pool's TAO value at its window open. The ROOT pool's y is its accrued root claimable over meta.root_yield_window against its root stake at the window open (pool-wide, net of take, at spot, before a claim's swap cost and RootClaimableThreshold): accrued, not realised. A rate, never a stake or income total. A signed ratio, 8 decimals. Null when a pool is refused (or none).

Format: decimal number, as a string · can be negative
apy_at_reference_stake_ratiostring · unit ratio · 8 decimals · can be null

The same on y x M: the APY a new stake of reference_stake_tao_rao would earn, with M the dilution of the reference stake X joining the pool (root: A / (A + X); a subnet: T/(T+X) x (s+X+K)/(s+K) x (A+R)/(A+X+R)). A constant-dividend model, the dividend held constant when X joins, so it understates under Yuma, where the dividend grows with stake. 8 decimals. Null with unavailable_reason (refused, no reference stake, an unpriced pool).

Format: decimal number, as a string · can be negative
reference_apr_ratiostring · unit ratio · 8 decimals · can be null

Σ w (y M x 365 / days) / Σ w: the simple (uncompounded) APR at the reference stake, breakeven_days' rate. 8 decimals. Null as apy_at_reference_stake_ratio.

Format: decimal number, as a string · can be negative
round_trip_cost_ratiostring · unit ratio · 8 decimals · can be null

1 - TAO back / the reference TAO, blended over the pools: the runtime's swap simulation at the day-end block (buy, then sell the alpha back against the same pool state); root 0. 8 decimals. Null while a pool's simulation is pending, or without a reference stake.

Format: decimal number, as a string · can be negative
entry_cost_ratiostring · unit ratio · 8 decimals · can be null

1 - alpha out x spot / the reference TAO, blended; root 0. 8 decimals. Null as round_trip_cost_ratio.

Format: decimal number, as a string · can be negative
exit_cost_ratiostring · unit ratio · 8 decimals · can be null

1 - TAO back / (alpha out x spot), blended; root 0. 8 decimals. Null as round_trip_cost_ratio.

Format: decimal number, as a string · can be negative
breakeven_daysstring · unit days · 2 decimals · can be null

round_trip_cost_ratio / (reference_apr_ratio / 365): the days the reference stake must stay to earn back its round trip, dividing exactly the cost served beside it by the APR served beside it (2 decimals). Null when either is, or when the served APR is not above 0 (unavailable_reason no_yield).

Format: decimal number, as a string · can be negative
unavailable_reasonstring · can be null

Why figures are null (precedence in this order): no_pools (no staked pool), pool_refused (a pool's return was refused: every APY and APR null), parent_set_unknown (a staked pool carries material childkey take, so its yield is rated over 1 day only until its per-day parent sets are stored) and window_too_short (a staked pool's yield window is shorter than its full window, 7 days or root's 30: a younger pool), either nulling every APY, the APR and the breakeven while the costs stay when known (parent_set_unknown is served when both hold), no_reference_stake (the reference figures and the costs null), pool_unpriced (a pool has no spot price: the reference APY, APR and breakeven null; nominator_apy_ratio stands), not_ready (the day's stake weights are not available yet: as pool_unpriced), swap_cost_pending (a pool's swap simulation has not run: the costs and breakeven null) or no_yield (the served reference_apr_ratio is not above 0, so only breakeven_days is null; the APYs, the APR and the costs are given). Null when every figure is given. New values may be added; treat unknown values as unavailable.

subnet_onlyobject · can be null

The same figures over the subnet pools only (netuid != 0; root apart): root's low yield and zero swap cost no longer dilute them. The top-level figures stay the blend over every pool, root included. Null on an older data version's answer.

8 fields in subnet_only
poolsinteger · unit count · can be null

The subnet pools blended (netuid != 0): the top-level pools without root, so never more than it.

nominator_apy_ratiostring · unit ratio · 8 decimals · can be null

As the top-level nominator_apy_ratio (Σ w ((1 + y)^(365 / days) - 1) / Σ w, the per-share return net of take, alpha-denominated), over the subnet pools only. A rate, never a total. 8 decimals. Null with unavailable_reason (no_pools, pool_refused).

Format: decimal number, as a string · can be negative
apy_at_reference_stake_ratiostring · unit ratio · 8 decimals · can be null

As the top-level apy_at_reference_stake_ratio (the constant-dividend model: the dividend held constant when the reference stake joins, so it understates under Yuma), over the subnet pools only, at the top-level reference_stake_tao_rao. 8 decimals. Null with unavailable_reason.

Format: decimal number, as a string · can be negative
round_trip_cost_ratiostring · unit ratio · 8 decimals · can be null

1 - TAO back / the reference TAO, blended over the subnet pools only (the runtime's swap simulation at the day-end block). Per pool 1 - round trip = (1 - entry) x (1 - exit), so it is entry + exit less their product, never more than entry + exit. 8 decimals. Null while a pool's simulation is pending, or without a reference stake.

Format: decimal number, as a string · can be negative
entry_cost_ratiostring · unit ratio · 8 decimals · can be null

1 - alpha out x spot / the reference TAO, blended over the subnet pools only. 8 decimals. Null as round_trip_cost_ratio.

Format: decimal number, as a string · can be negative
exit_cost_ratiostring · unit ratio · 8 decimals · can be null

1 - TAO back / (alpha out x spot), blended over the subnet pools only. 8 decimals. Null as round_trip_cost_ratio.

Format: decimal number, as a string · can be negative
breakeven_daysstring · unit days · 2 decimals · can be null

This block's round_trip_cost_ratio / (the subnet pools' reference APR / 365): the days the reference stake must stay in the subnet pools to earn back its round trip (2 decimals). The subnet APR itself is not served. Null when the round trip is, with unavailable_reason, or when that APR is not above 0 (no_yield).

Format: decimal number, as a string · can be negative
unavailable_reasonstring · can be null

Why this block's figures are null, as the top-level unavailable_reason over the subnet pools only: no_pools / pool_refused / parent_set_unknown / window_too_short (both APYs and the breakeven null; the costs stay when known), no_reference_stake (the reference APY, the costs and the breakeven), pool_unpriced / not_ready (the reference APY and the breakeven), swap_cost_pending (the costs and the breakeven), no_yield (the subnet pools' reference APR is not above 0: only the breakeven). Null when the APYs and the costs are given. New values may be added; treat unknown values as unavailable.

sparkline_7d_nav_per_unitarray of string · unit rao_per_share · 12 decimals · can be null

The realizable NAV per unit (rao per unit, 12 decimals) at the last 8 UTC day-end closes, oldest first; a day not available yet is absent, a day without units is null. Null on an older data version's answer.

trades_7dinteger · unit count · can be null

BasketSwapped events of the fund over the 7 days (50,400 blocks) to the day end. Null on an older data version's answer.

volume_7d_tao_raostring · unit rao (÷1e9) · can be null

The TAO leg at mid (taoMid) of those swaps, summed, rao. Null on an older data version's answer.

Format: whole number, as a string
owner_coldkeystring · can be null

Owner(hotkey) at the state head: the coldkey owning the validator, SS58 (prefix 42). Null on an older data version's answer.

Format: SS58 address
owner_namestring · can be null

The owner coldkey's on-chain identity name. Null without one. Null on an older data version's answer.

take_ratiostring · unit ratio · 6 decimals · can be null

Delegates take at the state head (u16 / 65535), a ratio, 6 decimals. Null when unset. Null on an older data version's answer.

Format: decimal number, as a string
dissolvedboolean · can be null

True when the fund is dissolved: absent from the runtime's basket list at the 2 swept anchors after its last one with units, and its BasketShares gone at the state head. A dissolved fund's page serves its last available day. Always false in the list. Null on an older data version's answer.

dissolved_heightinteger · unit block · can be null

The first anchor the fund was absent at. Null unless dissolved. In the list dissolved is always false. Null on an older data version's answer.

root_uidinteger · unit id · can be null

The fund hotkey's UID on root (netuid 0). Null when it is not registered on root. Null on an older data version's answer.

trading_statusobject · can be null

The fund's swap_basket gate and turnover bucket at the state head (not the served day end): served only when no at is asked (meta.head_fields), null with one. Null too when the fund has no swept holdings, and on an older answer.

9 fields in trading_status
is_trading_enabledboolean

BasketTradingEnabled: the network-wide switch.

is_frozenboolean

BasketTradingFrozen[hotkey]: governance froze this fund.

refill_blocksinteger · unit blocks

The bucket's refill window, blocks (a full refill per window).

tao_available_raostring · unit rao (÷1e9)

The bucket now: its stored level plus budget x elapsed / refill_blocks, capped at the budget (full when no bucket is stored), rao.

Format: whole number, as a string · on chain: u64
budget_raostring · unit rao (÷1e9)

The bucket's capacity: guarded NAV x BasketDailyTurnoverCap / 65535, rao.

Format: whole number, as a string · on chain: u64
guarded_nav_tao_raostring · unit rao (÷1e9)

The NAV the budget is a share of: per holding min(realizable, moving price x alpha) (root: realizable) at the fund's newest swept anchor (nav_as_of_block), rao. It can sit a little off the chain's while prices move.

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

The state head the status is read at.

nav_as_of_blockinteger · unit block

The swept anchor the guarded NAV is read at.

sourcestring

A constant marker (one value today, chain): the status is computed from chain state. New values may be added; show an unknown value as is (or generically).

nav_unavailable_reasonstring · can be null

Why nav_tao_rao is null: no_nav_row (no NAV row swept at the day end). Null otherwise, and on an older answer. Known values: no_nav_row, unpriced_holding, fund_dissolved. New values may be added; treat unknown values as unavailable.

holding_countinteger · unit count · can be null

The subnets the fund holds alpha in (alpha > 0) at its newest swept anchor at or before the day end: the same composition as include=holdings_by_subnet, counted. Null before the fund's first swept anchor. Null on an older data version's answer.

root_stakeobject · can be null

Option A: root stake to the fund's validator, with its holder-true accrual, realised claims, staker TWR and hold return as RatioFigures. Never combined with fund (no rate across options). Stored once per accrual day with its own as_of_day / as_of_height: the block of the latest accrual day, whatever day the list serves (so an answer carrying it is never cached as settled). Null before the fund's first store. Absent with view=summary (present, maybe null, otherwise).

21 fields in root_stake
optionstring

Always root_stake.

basisstring

The rate basis: the accrued claimable, holder-true. Known values: root_claimable_holder. New values may be added; show an unknown value as is (or generically).

has_root_uidboolean

The hotkey holds a root UID at as_of_height.

root_stake_tao_raostring · unit rao (÷1e9)

TotalHotkeyAlpha(hotkey, 0) at as_of_height (root is 1:1), rao of TAO: the pool the accrual dilutes over. 0 when none.

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

The Delegates take at the head, 0..1 (6 decimals). Null without a Delegates entry.

Format: decimal number, as a string
apy_7dobject

Holder-true accrual (APY): the fund units a TAO of root stake held through the window accrued, each day at that day's own realizable NAV per unit (the value at accrual), annualised; net of take, before the claim, the escrow share excluded. A rate, never an amount, and accrued: unrealised until claimed. NAV moves after the mint are hold_return_*, never here.

7 fields in apy_7d
valuestring · unit ratio · can be null

The figure, a signed ratio (1 = 100 %). Null exactly when unavailable_reason is set, and served only when days_ok = days_expected (checked).

Format: decimal number, as a string · can be negative
kindstring

apy: a compounded annual rate; apr: a simple annual rate; period: an un-annualised return or change over the window. New values may be added; show an unknown value as is (or generically).

from_daystring (date) · can be null

The window opens at this UTC day's end (to_day - days_expected). Null only with not_ready or not_applicable.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

The window closes at this UTC day's end: the block's as_of_day, at or before meta.at's day. Null with from_day.

Format: date, YYYY-MM-DD
days_okinteger · unit count · can be null

Whole UTC days of the window whose inputs are valid, 0..days_expected: how far a figure short of its window (insufficient_history) has got. Null with from_day.

days_expectedinteger · unit count

The nominal window in days: 7 or 30.

unavailable_reasonstring · can be null

Why value is null (each figure may give only the reasons its block lists, checked; no_deposits, nothing was ever deposited, only on a fund's lifetime_return); null exactly when value is given. Known values: not_ready, insufficient_history, not_applicable, no_root_uid, lost_root_uid_in_window, sell_gate_closed, fund_empty, fund_dissolved, fund_reset, share_collapse, dust_fund, provisional, unpriced_holding, no_nav_row, no_pool, pool_not_alive, no_permit, pool_refused, pool_unpriced, amount_too_large, below_min_stake, hotkey_not_on_root, nothing_owed, deposit_model_pending, swap_refused, price_unknown, no_deposits. New values may be added; treat unknown values as unavailable.

apy_30dobject

The same over 30 days.

7 fields in apy_30d
valuestring · unit ratio · can be null

The figure, a signed ratio (1 = 100 %). Null exactly when unavailable_reason is set, and served only when days_ok = days_expected (checked).

Format: decimal number, as a string · can be negative
kindstring

apy: a compounded annual rate; apr: a simple annual rate; period: an un-annualised return or change over the window. New values may be added; show an unknown value as is (or generically).

from_daystring (date) · can be null

The window opens at this UTC day's end (to_day - days_expected). Null only with not_ready or not_applicable.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

The window closes at this UTC day's end: the block's as_of_day, at or before meta.at's day. Null with from_day.

Format: date, YYYY-MM-DD
days_okinteger · unit count · can be null

Whole UTC days of the window whose inputs are valid, 0..days_expected: how far a figure short of its window (insufficient_history) has got. Null with from_day.

days_expectedinteger · unit count

The nominal window in days: 7 or 30.

unavailable_reasonstring · can be null

Why value is null (each figure may give only the reasons its block lists, checked; no_deposits, nothing was ever deposited, only on a fund's lifetime_return); null exactly when value is given. Known values: not_ready, insufficient_history, not_applicable, no_root_uid, lost_root_uid_in_window, sell_gate_closed, fund_empty, fund_dissolved, fund_reset, share_collapse, dust_fund, provisional, unpriced_holding, no_nav_row, no_pool, pool_not_alive, no_permit, pool_refused, pool_unpriced, amount_too_large, below_min_stake, hotkey_not_on_root, nothing_owed, deposit_model_pending, swap_refused, price_unknown, no_deposits. New values may be added; treat unknown values as unavailable.

accrual_period_return_7dstring · unit ratio · 12 decimals · can be null

The 7-day window's period return y behind apy_7d: the daily holder-true accrual summed over the window, 12 decimals (apy_7d = (1 + y)^(365/7) - 1, checked within its rounding). Exact where the 8-decimal APY rounds: compose an accrual at an amount from this, never from the APY. A rate, never an amount, and accrued. Null exactly when apy_7d is (checked), and on an answer from before it.

Format: decimal number, as a string · can be negative
accrual_period_return_30dstring · unit ratio · 12 decimals · can be null

The same over the 30-day window (apy_30d = (1 + y)^(365/30) - 1). Null exactly when apy_30d is.

Format: decimal number, as a string · can be negative
realised_apy_7dobject

The root claims executed on the hotkey in the window (BasketClaimed.tao) over the mean root stake held, annualised: the realised cross-check, lumpy.

7 fields in realised_apy_7d
valuestring · unit ratio · can be null

The figure, a signed ratio (1 = 100 %). Null exactly when unavailable_reason is set, and served only when days_ok = days_expected (checked).

Format: decimal number, as a string · can be negative
kindstring

apy: a compounded annual rate; apr: a simple annual rate; period: an un-annualised return or change over the window. New values may be added; show an unknown value as is (or generically).

from_daystring (date) · can be null

The window opens at this UTC day's end (to_day - days_expected). Null only with not_ready or not_applicable.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

The window closes at this UTC day's end: the block's as_of_day, at or before meta.at's day. Null with from_day.

Format: date, YYYY-MM-DD
days_okinteger · unit count · can be null

Whole UTC days of the window whose inputs are valid, 0..days_expected: how far a figure short of its window (insufficient_history) has got. Null with from_day.

days_expectedinteger · unit count

The nominal window in days: 7 or 30.

unavailable_reasonstring · can be null

Why value is null (each figure may give only the reasons its block lists, checked; no_deposits, nothing was ever deposited, only on a fund's lifetime_return); null exactly when value is given. Known values: not_ready, insufficient_history, not_applicable, no_root_uid, lost_root_uid_in_window, sell_gate_closed, fund_empty, fund_dissolved, fund_reset, share_collapse, dust_fund, provisional, unpriced_holding, no_nav_row, no_pool, pool_not_alive, no_permit, pool_refused, pool_unpriced, amount_too_large, below_min_stake, hotkey_not_on_root, nothing_owed, deposit_model_pending, swap_refused, price_unknown, no_deposits. New values may be added; treat unknown values as unavailable.

realised_apy_30dobject

The same over 30 days.

7 fields in realised_apy_30d
valuestring · unit ratio · can be null

The figure, a signed ratio (1 = 100 %). Null exactly when unavailable_reason is set, and served only when days_ok = days_expected (checked).

Format: decimal number, as a string · can be negative
kindstring

apy: a compounded annual rate; apr: a simple annual rate; period: an un-annualised return or change over the window. New values may be added; show an unknown value as is (or generically).

from_daystring (date) · can be null

The window opens at this UTC day's end (to_day - days_expected). Null only with not_ready or not_applicable.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

The window closes at this UTC day's end: the block's as_of_day, at or before meta.at's day. Null with from_day.

Format: date, YYYY-MM-DD
days_okinteger · unit count · can be null

Whole UTC days of the window whose inputs are valid, 0..days_expected: how far a figure short of its window (insufficient_history) has got. Null with from_day.

days_expectedinteger · unit count

The nominal window in days: 7 or 30.

unavailable_reasonstring · can be null

Why value is null (each figure may give only the reasons its block lists, checked; no_deposits, nothing was ever deposited, only on a fund's lifetime_return); null exactly when value is given. Known values: not_ready, insufficient_history, not_applicable, no_root_uid, lost_root_uid_in_window, sell_gate_closed, fund_empty, fund_dissolved, fund_reset, share_collapse, dust_fund, provisional, unpriced_holding, no_nav_row, no_pool, pool_not_alive, no_permit, pool_refused, pool_unpriced, amount_too_large, below_min_stake, hotkey_not_on_root, nothing_owed, deposit_model_pending, swap_refused, price_unknown, no_deposits. New values may be added; treat unknown values as unavailable.

staker_twr_7dobject

BasketTwr over the window (claim and restake, each dividend at realizable value), a period return.

7 fields in staker_twr_7d
valuestring · unit ratio · can be null

The figure, a signed ratio (1 = 100 %). Null exactly when unavailable_reason is set, and served only when days_ok = days_expected (checked).

Format: decimal number, as a string · can be negative
kindstring

apy: a compounded annual rate; apr: a simple annual rate; period: an un-annualised return or change over the window. New values may be added; show an unknown value as is (or generically).

from_daystring (date) · can be null

The window opens at this UTC day's end (to_day - days_expected). Null only with not_ready or not_applicable.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

The window closes at this UTC day's end: the block's as_of_day, at or before meta.at's day. Null with from_day.

Format: date, YYYY-MM-DD
days_okinteger · unit count · can be null

Whole UTC days of the window whose inputs are valid, 0..days_expected: how far a figure short of its window (insufficient_history) has got. Null with from_day.

days_expectedinteger · unit count

The nominal window in days: 7 or 30.

unavailable_reasonstring · can be null

Why value is null (each figure may give only the reasons its block lists, checked; no_deposits, nothing was ever deposited, only on a fund's lifetime_return); null exactly when value is given. Known values: not_ready, insufficient_history, not_applicable, no_root_uid, lost_root_uid_in_window, sell_gate_closed, fund_empty, fund_dissolved, fund_reset, share_collapse, dust_fund, provisional, unpriced_holding, no_nav_row, no_pool, pool_not_alive, no_permit, pool_refused, pool_unpriced, amount_too_large, below_min_stake, hotkey_not_on_root, nothing_owed, deposit_model_pending, swap_refused, price_unknown, no_deposits. New values may be added; treat unknown values as unavailable.

staker_twr_30dobject

The same over 30 days.

7 fields in staker_twr_30d
valuestring · unit ratio · can be null

The figure, a signed ratio (1 = 100 %). Null exactly when unavailable_reason is set, and served only when days_ok = days_expected (checked).

Format: decimal number, as a string · can be negative
kindstring

apy: a compounded annual rate; apr: a simple annual rate; period: an un-annualised return or change over the window. New values may be added; show an unknown value as is (or generically).

from_daystring (date) · can be null

The window opens at this UTC day's end (to_day - days_expected). Null only with not_ready or not_applicable.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

The window closes at this UTC day's end: the block's as_of_day, at or before meta.at's day. Null with from_day.

Format: date, YYYY-MM-DD
days_okinteger · unit count · can be null

Whole UTC days of the window whose inputs are valid, 0..days_expected: how far a figure short of its window (insufficient_history) has got. Null with from_day.

days_expectedinteger · unit count

The nominal window in days: 7 or 30.

unavailable_reasonstring · can be null

Why value is null (each figure may give only the reasons its block lists, checked; no_deposits, nothing was ever deposited, only on a fund's lifetime_return); null exactly when value is given. Known values: not_ready, insufficient_history, not_applicable, no_root_uid, lost_root_uid_in_window, sell_gate_closed, fund_empty, fund_dissolved, fund_reset, share_collapse, dust_fund, provisional, unpriced_holding, no_nav_row, no_pool, pool_not_alive, no_permit, pool_refused, pool_unpriced, amount_too_large, below_min_stake, hotkey_not_on_root, nothing_owed, deposit_model_pending, swap_refused, price_unknown, no_deposits. New values may be added; treat unknown values as unavailable.

hold_return_7dobject

Hold without claiming: the units accrued in the window marked at realizable NAV per unit at its end against their value at accrual, a period return. Served beside apy_7d, never added to it.

7 fields in hold_return_7d
valuestring · unit ratio · can be null

The figure, a signed ratio (1 = 100 %). Null exactly when unavailable_reason is set, and served only when days_ok = days_expected (checked).

Format: decimal number, as a string · can be negative
kindstring

apy: a compounded annual rate; apr: a simple annual rate; period: an un-annualised return or change over the window. New values may be added; show an unknown value as is (or generically).

from_daystring (date) · can be null

The window opens at this UTC day's end (to_day - days_expected). Null only with not_ready or not_applicable.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

The window closes at this UTC day's end: the block's as_of_day, at or before meta.at's day. Null with from_day.

Format: date, YYYY-MM-DD
days_okinteger · unit count · can be null

Whole UTC days of the window whose inputs are valid, 0..days_expected: how far a figure short of its window (insufficient_history) has got. Null with from_day.

days_expectedinteger · unit count

The nominal window in days: 7 or 30.

unavailable_reasonstring · can be null

Why value is null (each figure may give only the reasons its block lists, checked; no_deposits, nothing was ever deposited, only on a fund's lifetime_return); null exactly when value is given. Known values: not_ready, insufficient_history, not_applicable, no_root_uid, lost_root_uid_in_window, sell_gate_closed, fund_empty, fund_dissolved, fund_reset, share_collapse, dust_fund, provisional, unpriced_holding, no_nav_row, no_pool, pool_not_alive, no_permit, pool_refused, pool_unpriced, amount_too_large, below_min_stake, hotkey_not_on_root, nothing_owed, deposit_model_pending, swap_refused, price_unknown, no_deposits. New values may be added; treat unknown values as unavailable.

hold_return_30dobject

The same over 30 days.

7 fields in hold_return_30d
valuestring · unit ratio · can be null

The figure, a signed ratio (1 = 100 %). Null exactly when unavailable_reason is set, and served only when days_ok = days_expected (checked).

Format: decimal number, as a string · can be negative
kindstring

apy: a compounded annual rate; apr: a simple annual rate; period: an un-annualised return or change over the window. New values may be added; show an unknown value as is (or generically).

from_daystring (date) · can be null

The window opens at this UTC day's end (to_day - days_expected). Null only with not_ready or not_applicable.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

The window closes at this UTC day's end: the block's as_of_day, at or before meta.at's day. Null with from_day.

Format: date, YYYY-MM-DD
days_okinteger · unit count · can be null

Whole UTC days of the window whose inputs are valid, 0..days_expected: how far a figure short of its window (insufficient_history) has got. Null with from_day.

days_expectedinteger · unit count

The nominal window in days: 7 or 30.

unavailable_reasonstring · can be null

Why value is null (each figure may give only the reasons its block lists, checked; no_deposits, nothing was ever deposited, only on a fund's lifetime_return); null exactly when value is given. Known values: not_ready, insufficient_history, not_applicable, no_root_uid, lost_root_uid_in_window, sell_gate_closed, fund_empty, fund_dissolved, fund_reset, share_collapse, dust_fund, provisional, unpriced_holding, no_nav_row, no_pool, pool_not_alive, no_permit, pool_refused, pool_unpriced, amount_too_large, below_min_stake, hotkey_not_on_root, nothing_owed, deposit_model_pending, swap_refused, price_unknown, no_deposits. New values may be added; treat unknown values as unavailable.

sell_gate_7dobject

The root-sell gate over the 7-day window.

5 fields in sell_gate_7d
gate_open_blocksstring · unit blocks · can be null

Blocks of the window whose gate was open (root accrues only then), a u64 string, at most window_blocks (checked); fewer than it sets the accrual risk's sell_gate_closed_in_window for this window, and 0 is what the window's rate's sell_gate_closed means (both checked). Null with not_ready.

Format: whole number, as a string
window_blocksstring · unit blocks · can be null

The window's blocks (after from_day's close through to_day's), a u64 string. Null with not_ready.

Format: whole number, as a string
from_daystring (date) · can be null

The window's first UTC day end.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

Its last UTC day end.

Format: date, YYYY-MM-DD
unavailable_reasonstring · can be null

not_ready while a day of the window isn't available yet: every other member null. New values may be added; treat unknown values as unavailable.

sell_gate_30dobject

The root-sell gate over the 30-day window.

5 fields in sell_gate_30d
gate_open_blocksstring · unit blocks · can be null

Blocks of the window whose gate was open (root accrues only then), a u64 string, at most window_blocks (checked); fewer than it sets the accrual risk's sell_gate_closed_in_window for this window, and 0 is what the window's rate's sell_gate_closed means (both checked). Null with not_ready.

Format: whole number, as a string
window_blocksstring · unit blocks · can be null

The window's blocks (after from_day's close through to_day's), a u64 string. Null with not_ready.

Format: whole number, as a string
from_daystring (date) · can be null

The window's first UTC day end.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

Its last UTC day end.

Format: date, YYYY-MM-DD
unavailable_reasonstring · can be null

not_ready while a day of the window isn't available yet: every other member null. New values may be added; treat unknown values as unavailable.

risk_principalobject

The principal's risk: low.

4 fields in risk_principal
labelstring

The option's fixed label (root principal low, root accrual medium, fund units high); it never depends on data. Known values: low, medium, high, very_high. New values may be added; show an unknown value as is (or generically).

flagsarray of string

Window-free chain facts about this option (closed per option, checked; e.g. take_raised_30d, take_also_on_fund_holdings, trading_frozen, provisional). Never a judgement threshold. [] when none. Known values: take_raised_30d, take_also_on_fund_holdings, sell_gate_closed_in_window, lost_root_uid_in_window, trading_frozen, written_off_in_window, holdings_below_cap_minimum, provisional, thin_pool, no_permit_in_window, subtoken_disabled, stake_tier_low, perpetual_lock, lock_exceeds_holdings. New values may be added; show an unknown value as is (or generically).

flags_7darray of string · optional

The flags over the block's 7-day window (lost_root_uid_in_window, sell_gate_closed_in_window, written_off_in_window). Absent on a block with no figure over that window. Known values: take_raised_30d, take_also_on_fund_holdings, sell_gate_closed_in_window, lost_root_uid_in_window, trading_frozen, written_off_in_window, holdings_below_cap_minimum, provisional, thin_pool, no_permit_in_window, subtoken_disabled, stake_tier_low, perpetual_lock, lock_exceeds_holdings. New values may be added; show an unknown value as is (or generically).

flags_30darray of string · optional

The same over the 30-day window. Known values: take_raised_30d, take_also_on_fund_holdings, sell_gate_closed_in_window, lost_root_uid_in_window, trading_frozen, written_off_in_window, holdings_below_cap_minimum, provisional, thin_pool, no_permit_in_window, subtoken_disabled, stake_tier_low, perpetual_lock, lock_exceeds_holdings. New values may be added; show an unknown value as is (or generically).

risk_accrualobject

The accrual's risk: medium (it sits in the fund's units).

4 fields in risk_accrual
labelstring

The option's fixed label (root principal low, root accrual medium, fund units high); it never depends on data. Known values: low, medium, high, very_high. New values may be added; show an unknown value as is (or generically).

flagsarray of string

Window-free chain facts about this option (closed per option, checked; e.g. take_raised_30d, take_also_on_fund_holdings, trading_frozen, provisional). Never a judgement threshold. [] when none. Known values: take_raised_30d, take_also_on_fund_holdings, sell_gate_closed_in_window, lost_root_uid_in_window, trading_frozen, written_off_in_window, holdings_below_cap_minimum, provisional, thin_pool, no_permit_in_window, subtoken_disabled, stake_tier_low, perpetual_lock, lock_exceeds_holdings. New values may be added; show an unknown value as is (or generically).

flags_7darray of string · optional

The flags over the block's 7-day window (lost_root_uid_in_window, sell_gate_closed_in_window, written_off_in_window). Absent on a block with no figure over that window. Known values: take_raised_30d, take_also_on_fund_holdings, sell_gate_closed_in_window, lost_root_uid_in_window, trading_frozen, written_off_in_window, holdings_below_cap_minimum, provisional, thin_pool, no_permit_in_window, subtoken_disabled, stake_tier_low, perpetual_lock, lock_exceeds_holdings. New values may be added; show an unknown value as is (or generically).

flags_30darray of string · optional

The same over the 30-day window. Known values: take_raised_30d, take_also_on_fund_holdings, sell_gate_closed_in_window, lost_root_uid_in_window, trading_frozen, written_off_in_window, holdings_below_cap_minimum, provisional, thin_pool, no_permit_in_window, subtoken_disabled, stake_tier_low, perpetual_lock, lock_exceeds_holdings. New values may be added; show an unknown value as is (or generically).

as_of_daystring (date) · can be null

The to_day of the block's figures: the last available UTC day. Null while none is available.

Format: date, YYYY-MM-DD
as_of_heightinteger · unit block

The block the head values (stake, take, root UID) are read at, at or below meta.at.

fundobject · can be null

Option B: the fund units, the full block (state, NAVs and unit values, holder returns, composition, trading, display, risk). Stored once per accrual day like root_stake, with its own as_of_*. Null when not stored. Absent with view=summary (present, maybe null, otherwise).

21 fields in fund
optionstring

Always fund_units.

statestring

dissolved (worth exactly 0); no_state (no units outstanding, nothing held); off_root (units outstanding, no root UID: holders can still claim); active (units and a root UID). Checked against has_root_uid. New values may be added; show an unknown value as is (or generically).

has_root_uidboolean

The hotkey holds a root UID at as_of_height.

nav_realizable_tao_raostring · unit rao (÷1e9) · can be null

The fund's realizable NAV (its holdings as sold through each pool), rao of TAO. Null with nav_unavailable_reason (a dissolved fund's is null with fund_dissolved, checked), and on no_state.

Format: whole number, as a string · on chain: u64
nav_spot_tao_raostring · unit rao (÷1e9) · can be null

Its spot NAV (display), rao of TAO. Null together with the realizable NAV.

Format: whole number, as a string · on chain: u64
nav_unavailable_reasonstring · can be null

Why the NAVs are null (fund_dissolved: the fund is dissolved); null when they are given. Known values: no_nav_row, unpriced_holding, fund_dissolved. New values may be added; treat unknown values as unavailable.

units_outstandingstring · unit count · can be null

BasketShares: the fund's units outstanding (units, not TAO). Null on no_state.

Format: whole number, as a string
sum_owed_unitsstring · unit count · can be null

The units its holders are owed, summed (units).

Format: whole number, as a string
unowed_unitsstring · unit count · can be null

Units outstanding no holder is owed (units); a negative one is served as stated (a data-source defect, reported).

Format: whole number, as a string · can be negative
unit_value_realizable_raostring · unit rao_per_share · can be null

The realizable NAV per unit (rao of TAO per unit, 12 decimals). Null without a NAV or units.

Format: decimal number, as a string
unit_value_spot_raostring · unit rao_per_share · can be null

The spot NAV per unit (rao of TAO per unit). Null with the realizable one.

Format: decimal number, as a string
holder_return_7dobject

Option B's headline: the realizable NAV per unit over the window's day ends, minus 1, a period return (not annualised; flow-invariant, TAO terms).

7 fields in holder_return_7d
valuestring · unit ratio · can be null

The figure, a signed ratio (1 = 100 %). Null exactly when unavailable_reason is set, and served only when days_ok = days_expected (checked).

Format: decimal number, as a string · can be negative
kindstring

apy: a compounded annual rate; apr: a simple annual rate; period: an un-annualised return or change over the window. New values may be added; show an unknown value as is (or generically).

from_daystring (date) · can be null

The window opens at this UTC day's end (to_day - days_expected). Null only with not_ready or not_applicable.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

The window closes at this UTC day's end: the block's as_of_day, at or before meta.at's day. Null with from_day.

Format: date, YYYY-MM-DD
days_okinteger · unit count · can be null

Whole UTC days of the window whose inputs are valid, 0..days_expected: how far a figure short of its window (insufficient_history) has got. Null with from_day.

days_expectedinteger · unit count

The nominal window in days: 7 or 30.

unavailable_reasonstring · can be null

Why value is null (each figure may give only the reasons its block lists, checked; no_deposits, nothing was ever deposited, only on a fund's lifetime_return); null exactly when value is given. Known values: not_ready, insufficient_history, not_applicable, no_root_uid, lost_root_uid_in_window, sell_gate_closed, fund_empty, fund_dissolved, fund_reset, share_collapse, dust_fund, provisional, unpriced_holding, no_nav_row, no_pool, pool_not_alive, no_permit, pool_refused, pool_unpriced, amount_too_large, below_min_stake, hotkey_not_on_root, nothing_owed, deposit_model_pending, swap_refused, price_unknown, no_deposits. New values may be added; treat unknown values as unavailable.

holder_return_30dobject

The same over 30 days.

7 fields in holder_return_30d
valuestring · unit ratio · can be null

The figure, a signed ratio (1 = 100 %). Null exactly when unavailable_reason is set, and served only when days_ok = days_expected (checked).

Format: decimal number, as a string · can be negative
kindstring

apy: a compounded annual rate; apr: a simple annual rate; period: an un-annualised return or change over the window. New values may be added; show an unknown value as is (or generically).

from_daystring (date) · can be null

The window opens at this UTC day's end (to_day - days_expected). Null only with not_ready or not_applicable.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

The window closes at this UTC day's end: the block's as_of_day, at or before meta.at's day. Null with from_day.

Format: date, YYYY-MM-DD
days_okinteger · unit count · can be null

Whole UTC days of the window whose inputs are valid, 0..days_expected: how far a figure short of its window (insufficient_history) has got. Null with from_day.

days_expectedinteger · unit count

The nominal window in days: 7 or 30.

unavailable_reasonstring · can be null

Why value is null (each figure may give only the reasons its block lists, checked; no_deposits, nothing was ever deposited, only on a fund's lifetime_return); null exactly when value is given. Known values: not_ready, insufficient_history, not_applicable, no_root_uid, lost_root_uid_in_window, sell_gate_closed, fund_empty, fund_dissolved, fund_reset, share_collapse, dust_fund, provisional, unpriced_holding, no_nav_row, no_pool, pool_not_alive, no_permit, pool_refused, pool_unpriced, amount_too_large, below_min_stake, hotkey_not_on_root, nothing_owed, deposit_model_pending, swap_refused, price_unknown, no_deposits. New values may be added; treat unknown values as unavailable.

n_stakersinteger · unit count · can be null

The fund's stakers at its latest available day end (the fund row's n_stakers): the (fund hotkey, coldkey) pairs holding a root share key (Alpha / AlphaV2 on netuid 0) OR a BasketClaimed record, the fund escrow excluded; it includes stakers whose root stake is now 0 with a claim record, and dust is not excluded. The stakers with root stake > 0 are the fund row's n_stakers_with_stake (GET /baskets/{hotkey}).

first_blockinteger · unit block · can be null

The fund's first block. Null on no_state.

riskobject

The units' risk: high.

4 fields in risk
labelstring

The option's fixed label (root principal low, root accrual medium, fund units high); it never depends on data. Known values: low, medium, high, very_high. New values may be added; show an unknown value as is (or generically).

flagsarray of string

Window-free chain facts about this option (closed per option, checked; e.g. take_raised_30d, take_also_on_fund_holdings, trading_frozen, provisional). Never a judgement threshold. [] when none. Known values: take_raised_30d, take_also_on_fund_holdings, sell_gate_closed_in_window, lost_root_uid_in_window, trading_frozen, written_off_in_window, holdings_below_cap_minimum, provisional, thin_pool, no_permit_in_window, subtoken_disabled, stake_tier_low, perpetual_lock, lock_exceeds_holdings. New values may be added; show an unknown value as is (or generically).

flags_7darray of string · optional

The flags over the block's 7-day window (lost_root_uid_in_window, sell_gate_closed_in_window, written_off_in_window). Absent on a block with no figure over that window. Known values: take_raised_30d, take_also_on_fund_holdings, sell_gate_closed_in_window, lost_root_uid_in_window, trading_frozen, written_off_in_window, holdings_below_cap_minimum, provisional, thin_pool, no_permit_in_window, subtoken_disabled, stake_tier_low, perpetual_lock, lock_exceeds_holdings. New values may be added; show an unknown value as is (or generically).

flags_30darray of string · optional

The same over the 30-day window. Known values: take_raised_30d, take_also_on_fund_holdings, sell_gate_closed_in_window, lost_root_uid_in_window, trading_frozen, written_off_in_window, holdings_below_cap_minimum, provisional, thin_pool, no_permit_in_window, subtoken_disabled, stake_tier_low, perpetual_lock, lock_exceeds_holdings. New values may be added; show an unknown value as is (or generically).

as_of_daystring (date) · can be null

The fund's latest available UTC day (the figures' to_day).

Format: date, YYYY-MM-DD
as_of_heightinteger · unit block

The block the head values are read at.

displayvalue · optional

The display figures. Absent on a block that carries none.

compositionvalue · optional

The holdings' concentration at the fund's newest swept anchor at or before the day close. Absent where it is not served (directory rows, an older answer).

tradingvalue · optional

The trading status, 7-day swaps and the 30-day turnover. Absent where it is not served (directory rows, an older answer).

subnet_stake_spot_tao_raostring · unit rao (÷1e9) · can be null

The validator's stake on the subnets (netuid >= 1) at spot, rao of TAO (the validators index): a value, never a rate. Null when any staked pool is unpriced (never a partial sum) or the hotkey is not indexed. Null on an older data version's answer.

Format: whole number, as a string · on chain: u64
staked_subnet_countinteger · unit count · can be null

Subnets where the validator's pool holds stake (TotalHotkeyAlpha > 0; the validators index): a count, never a rate. Null when the hotkey is not indexed. Null on an older data version's answer.

staker_twr_since_inceptionobject · can be null

The staker TWR since the fund's current life began: BasketTwr at the served day / BasketTwr at the life's first stamped day (from_day) - 1, a period figure (days_expected = the days between them). The same definition as GET /baskets/{hotkey}/performance's returns.staker_twr_since_inception. Null on an older data version's answer.

7 fields in staker_twr_since_inception
valuestring · unit ratio · can be null

The figure, a signed ratio (1 = 100 %). Null exactly when unavailable_reason is set, and served only when days_ok = days_expected (checked).

Format: decimal number, as a string · can be negative
kindstring

apy: a compounded annual rate; apr: a simple annual rate; period: an un-annualised return or change over the window. New values may be added; show an unknown value as is (or generically).

from_daystring (date) · can be null

The window opens at this UTC day's end (to_day - days_expected). Null only with not_ready or not_applicable.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

The window closes at this UTC day's end: the block's as_of_day, at or before meta.at's day. Null with from_day.

Format: date, YYYY-MM-DD
days_okinteger · unit count · can be null

Whole UTC days of the window whose inputs are valid, 0..days_expected: how far a figure short of its window (insufficient_history) has got. Null with from_day.

days_expectedinteger · unit count

The nominal window in days: 7 or 30.

unavailable_reasonstring · can be null

Why value is null (each figure may give only the reasons its block lists, checked; no_deposits, nothing was ever deposited, only on a fund's lifetime_return); null exactly when value is given. Known values: not_ready, insufficient_history, not_applicable, no_root_uid, lost_root_uid_in_window, sell_gate_closed, fund_empty, fund_dissolved, fund_reset, share_collapse, dust_fund, provisional, unpriced_holding, no_nav_row, no_pool, pool_not_alive, no_permit, pool_refused, pool_unpriced, amount_too_large, below_min_stake, hotkey_not_on_root, nothing_owed, deposit_model_pending, swap_refused, price_unknown, no_deposits. New values may be added; treat unknown values as unavailable.

validator_take_30dobject · can be null

The take on the hotkey's root dividends over the 30 days to the served day (the ratio only; the amounts are on GET /baskets/{hotkey}/performance). Null on an older data version's answer.

1 field in validator_take_30d
take_ratioobject

The validator's take / its gross root dividend (take + the stakers' queued root claimable), each day valued at its subnet's day-end spot: a 30-day period figure (price_unknown while a day is unpriced, insufficient_history before 30 days with dividends).

7 fields in take_ratio
valuestring · unit ratio · can be null

The figure, a signed ratio (1 = 100 %). Null exactly when unavailable_reason is set, and served only when days_ok = days_expected (checked).

Format: decimal number, as a string · can be negative
kindstring

apy: a compounded annual rate; apr: a simple annual rate; period: an un-annualised return or change over the window. New values may be added; show an unknown value as is (or generically).

from_daystring (date) · can be null

The window opens at this UTC day's end (to_day - days_expected). Null only with not_ready or not_applicable.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

The window closes at this UTC day's end: the block's as_of_day, at or before meta.at's day. Null with from_day.

Format: date, YYYY-MM-DD
days_okinteger · unit count · can be null

Whole UTC days of the window whose inputs are valid, 0..days_expected: how far a figure short of its window (insufficient_history) has got. Null with from_day.

days_expectedinteger · unit count

The nominal window in days: 7 or 30.

unavailable_reasonstring · can be null

Why value is null (each figure may give only the reasons its block lists, checked; no_deposits, nothing was ever deposited, only on a fund's lifetime_return); null exactly when value is given. Known values: not_ready, insufficient_history, not_applicable, no_root_uid, lost_root_uid_in_window, sell_gate_closed, fund_empty, fund_dissolved, fund_reset, share_collapse, dust_fund, provisional, unpriced_holding, no_nav_row, no_pool, pool_not_alive, no_permit, pool_refused, pool_unpriced, amount_too_large, below_min_stake, hotkey_not_on_root, nothing_owed, deposit_model_pending, swap_refused, price_unknown, no_deposits. New values may be added; treat unknown values as unavailable.

validatorobject · can be null

Only with include=validator (absent otherwise): the fund hotkey's validator figures (stake, nominators, 30-day emission, age, permits, take) at the state head, not the day end, read from stored sets refreshed every ~20 blocks, never computed per request. Null when neither set holds the hotkey yet (counted in meta.validator.missing, with the reason).

19 fields in validator
sourcestring

Which stored set the figures came from (an opaque identifier): validators_index (the validators index: hotkeys with a validator permit or a root UID) or fund_validators (the rows for the fund hotkeys the index lacks). Both are refreshed every ~20 blocks; their heights are in meta.validator. New values may be added; show an unknown value as is (or generically).

stake_spot_tao_raostring · unit rao (÷1e9) · can be null

TotalHotkeyAlpha summed over the hotkey's subnets, each at its pool's spot price (root 1:1), rao of TAO: a spot value, not what unstaking would realise. root_stake_tao_rao + subnet_stake_spot_tao_rao when both are given (checked).

Format: whole number, as a string · on chain: u64
root_stake_tao_raostring · unit rao (÷1e9) · can be null

TotalHotkeyAlpha on root (netuid 0), rao of TAO (root is 1:1).

Format: whole number, as a string · on chain: u64
subnet_stake_spot_tao_raostring · unit rao (÷1e9) · can be null

The subnets' part (netuid >= 1) at spot, rao of TAO. Null when a staked pool is unpriced (never a partial sum).

Format: whole number, as a string · on chain: u64
nominator_positionsinteger · unit count · can be null

Live nominator positions over the hotkey's pools (one per coldkey per pool).

nominator_walletsinteger · unit count · can be null

Distinct coldkeys holding a non-zero share (Alpha / AlphaV2) on the hotkey over all its pools, each counted once.

emission_30d_spot_tao_raostring · unit rao (÷1e9) · can be null

The hotkey's realized emission over the last 30 available days (nominator dividend + validator and root take + miner incentive + owner cut; root claimable never included) at today's spot, rao of TAO. Null while that window lags.

Format: whole number, as a string · on chain: u64
first_seen_heightinteger · unit block · can be null

The block of the first write of the hotkey's Owner key (its creation).

last_seen_heightinteger · unit block · can be null

max(last_update, block_at_registration) over its neurons now. Null without a neuron.

validator_permitboolean · can be null

Whether it holds a validator permit on any subnet now.

root_uidboolean · can be null

Whether it holds a UID on root (netuid 0) now.

validator_subnet_countinteger · unit count · can be null

Subnets it holds a validator permit on now (at most subnet_count, checked).

subnet_countinteger · unit count · can be null

Subnets it holds a UID on now (Uids, root included).

take_ratiostring · unit ratio · can be null

Delegates take / 65535, a decimal string 0..1 (checked).

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

The hotkey's Owner coldkey's own positions on it (self-bonded), Alpha / AlphaV2 shares sized to alpha and valued at spot (root 1:1), rao of TAO: the hotkey's own_stake_spot_tao_rao. "0" when the owner holds none. Null when the hotkey has no Owner, when the stored set has not counted it yet, and on an older data version's answer.

Format: whole number, as a string · on chain: u64
nominator_positions_valuedinteger · unit count · can be null

As GET /validators' nominator_positions_valued: positions worth at least 1 rao at spot, module / escrow accounts excluded. Null with nominator_wallets_valued when not counted yet, and on an older data version's answer.

nominator_wallets_valuedinteger · unit count · can be null

Distinct coldkeys among nominator_positions_valued (at most it, checked). Null with it.

root_apy_7dobject · can be null

As GET /validators' root_apy_7d: option A's holder-true root accrual over 7 days (the stored A block's apy_7d; its window is the block's, not the served day's). no_root_uid (no window) for a hotkey without a root UID, not_ready (no window) while the stored set has no entry for it. A rate, never combined with the fund's returns. Null on an older data version's answer.

7 fields in root_apy_7d
valuestring · unit ratio · can be null

The figure, a signed ratio (1 = 100 %). Null exactly when unavailable_reason is set, and served only when days_ok = days_expected (checked).

Format: decimal number, as a string · can be negative
kindstring

apy: a compounded annual rate; apr: a simple annual rate; period: an un-annualised return or change over the window. New values may be added; show an unknown value as is (or generically).

from_daystring (date) · can be null

The window opens at this UTC day's end (to_day - days_expected). Null only with not_ready or not_applicable.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

The window closes at this UTC day's end: the block's as_of_day, at or before meta.at's day. Null with from_day.

Format: date, YYYY-MM-DD
days_okinteger · unit count · can be null

Whole UTC days of the window whose inputs are valid, 0..days_expected: how far a figure short of its window (insufficient_history) has got. Null with from_day.

days_expectedinteger · unit count

The nominal window in days: 7 or 30.

unavailable_reasonstring · can be null

Why value is null (each figure may give only the reasons its block lists, checked; no_deposits, nothing was ever deposited, only on a fund's lifetime_return); null exactly when value is given. Known values: not_ready, insufficient_history, not_applicable, no_root_uid, lost_root_uid_in_window, sell_gate_closed, fund_empty, fund_dissolved, fund_reset, share_collapse, dust_fund, provisional, unpriced_holding, no_nav_row, no_pool, pool_not_alive, no_permit, pool_refused, pool_unpriced, amount_too_large, below_min_stake, hotkey_not_on_root, nothing_owed, deposit_model_pending, swap_refused, price_unknown, no_deposits. New values may be added; treat unknown values as unavailable.

root_apy_30dobject · can be null

root_apy_7d over 30 whole days (the A block's apy_30d), the same refusals. Null on an older data version's answer.

7 fields in root_apy_30d
valuestring · unit ratio · can be null

The figure, a signed ratio (1 = 100 %). Null exactly when unavailable_reason is set, and served only when days_ok = days_expected (checked).

Format: decimal number, as a string · can be negative
kindstring

apy: a compounded annual rate; apr: a simple annual rate; period: an un-annualised return or change over the window. New values may be added; show an unknown value as is (or generically).

from_daystring (date) · can be null

The window opens at this UTC day's end (to_day - days_expected). Null only with not_ready or not_applicable.

Format: date, YYYY-MM-DD
to_daystring (date) · can be null

The window closes at this UTC day's end: the block's as_of_day, at or before meta.at's day. Null with from_day.

Format: date, YYYY-MM-DD
days_okinteger · unit count · can be null

Whole UTC days of the window whose inputs are valid, 0..days_expected: how far a figure short of its window (insufficient_history) has got. Null with from_day.

days_expectedinteger · unit count

The nominal window in days: 7 or 30.

unavailable_reasonstring · can be null

Why value is null (each figure may give only the reasons its block lists, checked; no_deposits, nothing was ever deposited, only on a fund's lifetime_return); null exactly when value is given. Known values: not_ready, insufficient_history, not_applicable, no_root_uid, lost_root_uid_in_window, sell_gate_closed, fund_empty, fund_dissolved, fund_reset, share_collapse, dust_fund, provisional, unpriced_holding, no_nav_row, no_pool, pool_not_alive, no_permit, pool_refused, pool_unpriced, amount_too_large, below_min_stake, hotkey_not_on_root, nothing_owed, deposit_model_pending, swap_refused, price_unknown, no_deposits. New values may be added; treat unknown values as unavailable.

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.