TAO balance history of an account
https://api.bittensor.ai/api/v2/accounts/{address}/history- Status
- Stable
- Auth
- API key or OAuth access token
- Scope
data:read- Rate limit
plan
Every change of the account's TAO balance (each System.Account write), newest first: when in the block it happened, the extrinsic and its outer call, the event that explains it, a category, and the signed free/reserved deltas with the balances after. Alpha (stake) changes are per position, in /accounts/{address}/positions/{hotkey}/{netuid}/history. limit is at most 200 here (default 50), below the API-wide 1000, because every row is attributed on read; a full page can take tens of seconds cold. A Balances.Transfer names its counterparty, and counterparty_account_kind what it is from its bytes (custody, protocol or account; null with counterparty). Pages go back in time through meta.page.next_cursor, which is present only when another page exists. The page that reaches meta.coverage.from_height has meta.page.end_of_coverage: true. meta.page.has_older_outside_coverage (a boolean on every page) says whether older history exists below coverage (not served yet). Errors are application/problem+json: INVALID_ADDRESS, INVALID_LIMIT, INVALID_CURSOR, INVALID_HEIGHT, UNKNOWN_PARAMETER, SOURCE_TIMEOUT (503), SOURCE_NOT_READY (503).
Path parameters
- addresspath, required· string
The account (coldkey): SS58, or 0x + 64 hex.
Query parameters
- limitquery· integer · default 50 · 1 to 200
Page size, 1..200 (this route's cap; above it is a 400
INVALID_LIMIT).- cursorquery· string · up to 200 characters
meta.page.next_cursorof the previous page, passed back unchanged with the same other parameters. It is opaque and bound to them: a cursor used with different parameters, or altered, is a 400INVALID_CURSOR.- to_heightquery· integer · 0 to 2147483647
Only changes at or below this block height.
- includequery· string
namesadds the top-levelincluded.names: every distinct account on the page (accounts indataat any depth, event args included) keyed by its SS58 address, each{identity: {name} | null, label: {text, source, confidence, verified, inferred, as_of} | null}; the on-chain identity and the off-chain label are kept apart, and a label is never a chain fact. A missing key means 'not looked up', null means 'none'. At most 500 accounts (included.names_truncated). Still one call (the data source sideloads them in the same statement); an answer with names is cached as a head answer (names follow the head). Anything else is a 400INVALID_INCLUDE.
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.
Balance changes, newest first; [] when there are none in coverage.
- idstring · unit id
height-seqof the storage write; unique and stable.- Format: block and index, such as 4200000-3
- heightinteger · unit block
Block of the write.
- timestring (date-time)
Timestamp of that block, RFC 3339 UTC.
- Format: date and time, ISO 8601 in UTC
- phasestring
When in the block the write happened:
extrinsic,block_start(on_initialize hooks) orblock_end(on_finalize hooks). Clients must accept values not documented yet.- extrinsicstring · unit id · can be null
The extrinsic (
height-index) that made the write; null for a block hook.- Format: block and index, such as 4200000-3
- callstring · can be null
Pallet.callof that extrinsic: the OUTER call, so a batch or a proxy shows as such. Null for a block hook.- eventstring · can be null
Pallet.Eventthat explains the write (it names the account, and carries the exact amount when one matches). Null when no event does.- event_indexinteger · unit id · can be null
Index of that event in the block; null with
event.- categorystring
What the change was:
transfer_in,transfer_out,fee,fee_refund,stake,unstake,move_stake,root_claim,register,coldkey_swap,reserve,unreserve,dust,evm,block_hook,deposit,withdraworother. Clients must accept values not documented yet.- counterpartystring · can be null
Transfer counterparty, SS58: the other account of a
Balances.Transfer(the recipient of atransfer_out, the sender of atransfer_in). Null for every row not explained by aBalances.Transfer, even when TAO moved between two accounts another way.- Format: SS58 address
- counterparty_account_kindobject · can be null
What
counterpartyis, from its bytes:custody,protocolor a plainaccount. Null exactly whencounterpartyis null.4 fields in counterparty_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
modlprefix as text (e.g.subtensr,bt/cloan). Null whenkindisaccount.- 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) ortag(8 printable bytes, e.g.beta/escfor 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
netuidandindex, a string fortag.
- 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.
- free_delta_raostring · unit rao (÷1e9)
Change of the free balance, signed, in rao.
- Format: whole number, as a string · can be negative
- free_after_raostring · unit rao (÷1e9)
Free balance after the write, in rao.
- Format: whole number, as a string · on chain: u64
- reserved_delta_raostring · unit rao (÷1e9)
Change of the reserved balance, signed, in rao.
- Format: whole number, as a string · can be negative
- reserved_after_raostring · unit rao (÷1e9)
Reserved balance after the write, in rao.
- Format: whole number, as a string · on chain: u64
- delta_usdstring · unit usd · 6 decimals · can be null
(free_delta + reserved_delta) in USD, signed, 6 decimals, at the TAO/USD price of the write's own minute: event rows are valued when they happened, not at
meta.at. Null when no price exists for that minute.- 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), slowpublic, max-age=300, stale-while-revalidate=600(state that moves in minutes or days) or tippublic, max-age=6, stale-while-revalidate=12(follows the chain head); the label routes are cached until the next nightly copy (public, max-age=<seconds>, stale-while-revalidate=60). Neverimmutable.no-storeon an earlier answer served because the data source failed (X-BTAI-Stale).- CDN-Cache-Control
The same class for shared caches (RFC 9213; browsers ignore it): settled 24 h, slow 300 s, tip 6 s, each with
stale-while-revalidateandstale-if-error;no-storewithX-BTAI-Stale.- X-BTAI-Stale
Present only when the data source failed to answer (it timed out or was unavailable) and an earlier answer to the same request is served instead of a 503 (stale if error, RFC 5861). Then
if-error, withX-BTAI-Stale-As-Of,Age(its seconds since then) andWarning: 110 - "Response is Stale", andCache-Control: no-store: the answer is never kept as fresh, and a later request reads again. Prices and quotes are never served this way.- X-BTAI-Stale-As-Of
With
X-BTAI-Stale: when the earlier answer served was produced, an RFC 3339 UTC time (2026-10-21T12:00:00Z).- RateLimit-Policy
The tier's request quota of the current window (IETF draft), e.g.
"tier";q=600.- RateLimit
Requests left in the current window and the seconds until it resets (IETF draft), e.g.
"tier";r=597;t=42.- X-RateLimit-Limit
The tier's request quota of the current window.
- X-RateLimit-Remaining
Requests left in the current window.
- X-RateLimit-Reset
When the current window resets, Unix seconds.
Status codes
200 · 304 · 400 · 401 · 402 · 403 · 404 · 429 · 500 · 502 · 503
304 Not Modified: the If-None-Match validator still matches; no body.
Error codes
The codes this endpoint can return. Each links to what it means and what to do.
- ADDRESS_NOT_IN_PLAN_SCOPE
- AMBIGUOUS_CREDENTIALS
- BAD_GATEWAY
- BILLING_UNAVAILABLE
- BUDGET_EXCEEDED
- CONCURRENCY_LIMIT
- INSUFFICIENT_PERMISSIONS
- INTERNAL_ERROR
- INVALID_ADDRESS
- INVALID_CURSOR
- INVALID_HEIGHT
- INVALID_INCLUDE
- INVALID_LIMIT
- PAYMENT_REQUIRED
- RATE_LIMITED
- REPEATED_PARAMETER
- SERVICE_UNAVAILABLE
- SOURCE_BUSY
- SOURCE_NOT_READY
- SOURCE_TIMEOUT
- UNAUTHORIZED
- UNKNOWN_PARAMETER
- VALIDATION_ERROR
From the API's published specification, version 1.165.0.