Skip to content
TAO$189.47
BTC0.002937
MCap$2.22B
Vol$87.29M

API reference / Staking

The network's root accrual rate: the stake-weighted mean of the validators' root accrual

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

A fact about the network, not a staking option: the stake-weighted mean of every root validator's holder-true option-A accrual (the fund units a TAO of root stake accrues, each day at that day's realizable NAV per unit, net of the validator's own take), as a period return y = sum S_i y_i / sum S_i over the validators with a root UID at as_of_day and a valid window (S_i its root stake at the window open), annualised (1 + y)^(365 / days) - 1, over 7 and 30 days. Never shown beside a single validator's rate as an alternative, and never combined with another option's rate. The top-level members are the 7-day window's; windows carries both, each with its rated validators, the excluded ones counted by reason, the weight and the period return. Accrued, unrealised until claimed: a rate, never an amount. The latest available day by default, or to_day: a day not available yet is a 503 NOT_READY. Cached as slow (a day is added once a day); an explicit, finalized to_day as settled. Errors are application/problem+json: INVALID_DAY, INVALID_RANGE (a to_day before the chain's first day), 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

to_dayquery· string (date)

The last UTC day of both windows, YYYY-MM-DD (default: the latest available day). A day not available yet is a 503 NOT_READY; a day before the chain's first block (2023-03-20) a 400 INVALID_RANGE; anything else a 400 INVALID_DAY.

Format: date, YYYY-MM-DD

Response

data is an object 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 network figures and their windows.

labelstring

What the figure is, always stake_weighted_mean_of_validator_root_accrual. New values may be added; show an unknown value as is (or generically).

basisstring

The rate basis of every member: the holder-true accrued claimable (option A's). Known values: root_claimable_holder. New values may be added; show an unknown value as is (or generically).

apy_7dobject

The 7-day network APY: windows.7d.figure (checked equal).

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 30-day network APY: windows.30d.figure (checked equal).

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.

validators_ratedinteger · unit count

The 7-day window's rated validators (windows.7d).

validators_excludedobject

The 7-day window's exclusions (windows.7d). Validators with a root UID at as_of_day left out of this window, counted by the reason their own option-A figure gives (e.g. insufficient_history, no_root_uid, lost_root_uid_in_window); {} when none. 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.

weight_root_stake_tao_raostring · unit rao (÷1e9)

The 7-day window's weight (windows.7d): the rated validators' root stake at its open.

Format: whole number, as a string · on chain: u64
as_of_daystring (date)

The last UTC day of both windows (their to_day).

Format: date, YYYY-MM-DD
windowsobject

Both windows, each with its figure, members and weight.

2 fields in windows
7dobject

The 7-day window (the top-level members' window).

5 fields in 7d
figureobject

The network APY over the window: (1 + period_return)^(365 / days) - 1 (checked), a value only when at least one validator is rated.

validators_ratedinteger · unit count

Validators whose window is valid: the mean's members.

validators_excludedobject

Validators with a root UID at as_of_day left out of this window, counted by the reason their own option-A figure gives (e.g. insufficient_history, no_root_uid, lost_root_uid_in_window); {} when none. 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.

weight_root_stake_tao_raostring · unit rao (÷1e9)

The rated validators' root stake at the window open, summed: the mean's weight, rao of TAO.

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

The weighted mean of the rated validators' period returns (y = sum S_i y_i / sum S_i, each net of its own take), un-annualised, a signed ratio (12 decimals). Null exactly when figure.value is.

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

The 30-day window (apy_30d).

5 fields in 30d
figureobject

The network APY over the window: (1 + period_return)^(365 / days) - 1 (checked), a value only when at least one validator is rated.

validators_ratedinteger · unit count

Validators whose window is valid: the mean's members.

validators_excludedobject

Validators with a root UID at as_of_day left out of this window, counted by the reason their own option-A figure gives (e.g. insufficient_history, no_root_uid, lost_root_uid_in_window); {} when none. 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.

weight_root_stake_tao_raostring · unit rao (÷1e9)

The rated validators' root stake at the window open, summed: the mean's weight, rao of TAO.

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

The weighted mean of the rated validators' period returns (y = sum S_i y_i / sum S_i, each net of its own take), un-annualised, a signed ratio (12 decimals). Null exactly when figure.value is.

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

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.