Skip to content
TAO$188.31
BTC0.002929
MCap$2.21B
Vol$86.07M

API reference / Hotkeys

A hotkey's emission credits, component by component

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

Every emission credit on the hotkey, newest first, one row per component credited in a block on a subnet: miner_incentive, validator_take, nominator_dividend, owner_cut, root_take, root_claimable_queued (root dividends accrued, not yet claimed), ... (type, an open set). Each row has the alpha credited and its TAO value at that block's price (root 1:1; null when unpriced), the staker credited (coldkey; null for a pool-wide credit) and, for incentive paid through a collateral hotkey, source_hotkey. Accounts are SS58. netuid narrows it to one subnet, types to some components. The window is from_height..to_height, both inclusive like every other height window; from_height defaults to 7,199 blocks below to_height (default: the head), 7,200 blocks, about a day; meta.from_height / meta.to_height say what was scanned (inclusive). Keyset-paged by meta.page.next_cursor. include=names adds the accounts' names. A pinned window below the head is cached 300 s (emission history can be re-derived); anything else as head state. Errors are application/problem+json: INVALID_ADDRESS, INVALID_NETUID, INVALID_TYPE, INVALID_RANGE, INVALID_LIMIT, INVALID_CURSOR, INVALID_INCLUDE, UNKNOWN_PARAMETER, NOT_READY (503), SOURCE_TIMEOUT (503), SOURCE_NOT_READY (503).

Beta: this route may change with one release's notice in the v2 changelog; additive changes need none (x-stability: beta).

Path parameters

hotkeypath, required· string

The hotkey: SS58, or 0x + 64 hex.

Query parameters

netuidquery· integer · 0 to 65535

Only credits on this subnet.

typesquery· string

Only these components (comma list or repeated, OR), e.g. miner_incentive,owner_cut; at most 16. Default: every component.

from_heightquery· integer · 0 to 2147483647

Only credits at or above this height (inclusive). Default: to_height - 7,199 (a window of 7,200 blocks). Above to_height is a 400 INVALID_RANGE.

to_heightquery· integer · 0 to 2147483647

Only credits at or below this height (inclusive). Default: the head.

limitquery· integer · default 50 · 1 to 200

Page size, 1..200 (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.

The credits, newest first.

heightinteger · unit block

The block the credit was paid in.

timestring (date-time) · can be null

The block's timestamp, RFC 3339 UTC. Null on an older data-source answer.

Format: date and time, ISO 8601 in UTC
netuidinteger · unit id

The subnet the credit is on (0 = root).

typestring

The credit's component: miner_incentive, validator_take, nominator_dividend, owner_cut, root_take, root_claimable_queued (root dividends accrued, unclaimed), basket_flush_credit, lease_distribution, unlabeled, ... (an open set: new components appear as the runtime adds them).

alpha_raostring · unit alpha_rao (÷1e9)

The alpha credited, alpha rao of netuid (root: rao of TAO).

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

alpha_rao x the subnet's runtime price at that block, floored, rao of TAO (root 1:1). Null when the block has no price.

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

The staker credited, SS58 (prefix 42); null for a pool-wide credit (the hotkey's pool as a whole, shared by its stakers).

Format: SS58 address
source_hotkeystring · can be null

For a miner_incentive paid through a collateral hotkey: the hotkey it came from, SS58 (prefix 42). Null otherwise.

Format: SS58 address

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.