Get Wallet Cost Basis Series (POST)
https://api.bittensor.ai/api/v2/accounts/cost-basis/series/batch- Status
- Beta
- Auth
- API key or OAuth access token
- Scope
data:read- Rate limit
plan
GET /accounts/cost-basis/series for up to 500 accounts: the body is {addresses, asset, netuid, from_day, to_day, currency, group_by, group_limit}}, the answer the GET form's.
Full description
GET /accounts/cost-basis/series for up to 500 accounts: the body is {addresses, asset, netuid, from_day, to_day, currency, group_by, group_limit}}, the answer the GET form's. How a set of accounts' cost basis, value and returns moved, day by day: per UTC day, the set's basis, value and unrealized gain at the close, the day's realized gain (and the cumulative one), income by kind, flows in and out of the set, and the day's price effect, in TAO (and in the reporting currency where priced; the price effect in it, split into the exchange-rate and market parts, is null until the flows are valued in that currency). The accounts are summed as one portfolio (a repeated address counts once). Large sets are computed in parts and combined; the results are identical to computing the set at once.
## Use cases - Performance chart: value against basis over time, with income and price effect apart. - Attribution: how much of a period's change came from income, price moves, realizations and flows. - Per subnet: netuid (and asset) restricts the series to one subnet or asset.
## Business logic Average-cost basis per position, a position being one (account, asset, subnet, subnet life): every acquisition adds its cost (TAO paid, or the value at receipt for income) and every disposal removes the average cost of the units it takes. Assets: alpha (subnet stake), root (root stake), tao_free (free TAO), tao_claims (TAO owed back to the account: refundable locks, crowdloan contributions, contract deposits and the payouts still due from a removed subnet), basket (fund units) and lp (liquidity positions). Income is valued at receipt and split by kind: subnet emission, root dividends, root pool growth, hotkey-swap misallocation (value gained when a hotkey swap, before the chain changed swaps in March 2026, combined two stake pools without repricing their shares), the block author's fee share and subnet-owner emission. Growth of subnet alpha pools is served beside them (income_growth_*, all pool growth) but is value growth, not income. Burns and standalone transaction fees are expenses of their value (burn_cost_*, fee_cost_standalone_*), each also a disposal at the average cost. Unrealized = value - basis (signed); realized is the gain on disposals since the first acquisition. Root dividends accrued but not yet claimed are not in any amount. The day's realized gain is the gain on that day's disposals; the cumulative one runs from the first acquisition.
## Window from_day..to_day (UTC days, inclusive); to_day defaults to the newest available day and is clamped to it (meta.to_day), from_day is clamped to meta.coverage_from_day and defaults to the 30 days ending at to_day. At most 3660 days.
## Groups group_by=netuid (per subnet life) or group_by=asset splits every day into one row per group, each naming its group; within a day, rows are by TAO value on the last day served, largest first. group_limit=N keeps the same top N groups on every day and sums the rest into one other row per day. units is served on netuid groups only (units of different subnets are never summed). A grouped series spans at most 2000 days.
## Known issue A small residual of sales still takes more units than the position held at that point in its day: the extra units leave with no cost, so that sale's realized gain is overstated and the cost basis of the units acquired afterwards is understated by the same amount; over the position's whole life the total is unchanged, only its timing moves. Units that arrived without a matching recorded acquisition are given a cost at the day's closing price instead of being shown as unknown. Root rewards that the chain claimed and swapped to TAO automatically (blocks 6,811,691 to 8,765,683) are counted as income at the TAO received, not at the fair value of the alpha claimed; the swap's slippage is therefore left out of both income and realized gain. Income received in a block where the pool was traded earlier in the same block is valued at the price before those trades, not at the price after the block; this overstates income, almost all of it received between 23 February and 24 March 2025. Holdings are valued at the pool's spot price at the day's close; on a pool too thin to be an active market, that is not its fair value, so value and unrealized gain there are overstated. A sale's realized gain counts its swap fee as part of the proceeds, so it is overstated by that fee. Corrections are in progress; the affected figures change when they are served.
## Unknown figures A figure that cannot be known is null with a reason in the row's unavailable_reasons, never 0: unvalued (some units entered with no known cost: unvalued_units; the basis is unknown), price_unknown (the asset's close price is unknown, so its value is unknown in TAO and in the reporting currency), rate_unknown (the TAO figure is known but the rate to the reporting currency is not: only the figure in that currency is null), flows_unvalued (a day's price effect, while its flows are not all valued; in the reporting currency the price effect is not computed yet, so it is null there). Unrealized and totals use known figures only. meta.available_assets lists the assets covered so far: another asset has no figures yet.
## Data freshness Computed from the analytics store after each UTC day closes: the newest day is meta.through_day, and meta.sources names the store and its last block. A day more than 6 hours overdue (at most 36) is still served, labelled by meta.through_day, with the response headers X-BTAI-Data-Through: <YYYY-MM-DD> and X-BTAI-Overdue-S: <seconds> (cached as slow). A store more than 36 hours overdue, or still computing, is a 503 SOURCE_NOT_READY with Retry-After. While the figures are recalculated under a corrected method, a range that spans recalculated and not yet recalculated days is a 503 RECALCULATING with Retry-After: an answer never mixes the two. Where this deployment does not serve cost basis yet, every route is a 503 SOURCE_NOT_READY.
The body's unknown members are a 400 UNKNOWN_PARAMETER; the answer is not cached (no-store).
## Errors application/problem+json: ADDRESSES_REQUIRED, BATCH_TOO_LARGE, INVALID_ADDRESS, INVALID_ASSET, INVALID_NETUID, INVALID_CURRENCY, INVALID_GROUP_BY, INVALID_GROUP_LIMIT, INVALID_DAY, INVALID_RANGE, RANGE_TOO_LARGE (over 3660 days, or 2000 when grouped), UNKNOWN_PARAMETER, NOT_READY (503, reason day_not_closed: the day asked is after the newest available day), SOURCE_TIMEOUT (503), SOURCE_NOT_READY (503), RECALCULATING (503, Retry-After: a recalculation is part-way through the range), SERVICE_UNAVAILABLE (503), BAD_GATEWAY (502).
Beta: this route may change with one release's notice in the v2 changelog; additive changes need none (x-stability: beta).
Request body
A JSON object with these fields:
- addressesarray of string
The accounts (coldkeys), SS58 or 0x + 64 hex, 1..500, summed as one set (a duplicate counts once in the figures, as given in the metering). An empty list is a 400
ADDRESSES_REQUIRED, more than 500 a 400BATCH_TOO_LARGE, an invalid one a 400INVALID_ADDRESSnaming its index (addresses[i]).- assetstring · can be null
As the GET form's
asset:alpha,root,tao_free,tao_claims,basketorlp(else a 400INVALID_ASSET).- netuidinteger · can be null
As the GET form's
netuid(0..65535).- currencystring · can be null
As the GET form's
currency(defaultUSD).- from_daystring · can be null
As the GET form's
from_day.- to_daystring · can be null
As the GET form's
to_day.- group_bystring · can be null
As the GET form's
group_by(netuidorasset).- group_limitinteger · can be null
As the GET form's
group_limit(default 0).
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.
One row per available day in meta.from_day..meta.to_day, oldest first, for the set of distinct addresses as one portfolio; [] when none.
- daystring (date)
The UTC day (its close).
- Format: date, YYYY-MM-DD
- groupobject · can be null
With
group_by: the group this row sums (the same groups on every day whengroup_limitis set); null when not grouped (the row is the whole set).7 fields in group
- kindstring
netuid: one subnet life (netuid,generation,life_start_height; forbasketpositions, one fund:fund_hotkey).asset: one asset (asset;basketis all funds together).other: every group outside the topgroup_limit, summed (its other members are null). New values may be added; show an unknown value as is (or generically).- netuidinteger · unit id · can be null
The subnet (0 = root) of a
netuidgroup; null otherwise.- generationinteger · unit id · can be null
Opaque life id (the life's registration identifier), NOT a block height; use
life_start_heightfor the first block. The subnet life of anetuidgroup; null otherwise.- life_start_heightinteger · unit block · can be null
The first block of the life
generationnames (GET /subnets/generations'start_height): use it, nevergeneration, for heights, ages and dates. Null exactly whengenerationis null (root without a life, no subnet), or transiently when this API cannot read the lives. Root'sgeneration0 starts at 0.- is_current_lifeboolean · can be null
Whether
generationis the slot's current life (true) or an ended one, re-registered since (false). Null exactly whengenerationis null, or transiently when this API cannot read the lives. Root'sgeneration0 is current.- assetstring · can be null
The asset of an
assetgroup, or of anetuidgroup's positions (rootorbasketon netuid 0,alphaelsewhere); null forother. New values may be added; show an unknown value as is (or generically). Known values:alpha,root,tao_free,tao_claims,basket,lp.- fund_hotkeyobject · can be null
The fund (its hotkey) of a
netuidgroup ofbasketpositions: one group per fund; null otherwise. Its money-weighted return (include=mwr) is all the funds together.2 fields in fund_hotkey
- ss58string
The account, SS58 (prefix 42).
- Format: SS58 address
- hexstring
The same 32-byte account id, 0x + 64 lower-case hex (the public key).
- Format: 32-byte hex: 0x and 64 hex digits
- unitsstring · unit lot_quantity (per quantity_unit) · can be null
Units held at the close by a
netuidgroup (1e-9 alpha of its subnet; TAO on root). Never negative (>= 0). Null on the whole set, anassetgroup orother(mixed_units: units of different subnets are never summed).- Format: whole number, as a string
- income_unitsstring · unit lot_quantity (per quantity_unit) · can be null
This day's income in units, for a
netuidgroup (asunits): emission + root dividends + root pool growth + hotkey-swap misallocation (signed; subnet alpha pool growth is not income). Negative on a day the chain took back an earlier misallocation gain. Null elsewhere (mixed_units), and on anetuidgroup where it is not computed yet (not_ready).- Format: whole number, as a string · can be negative
- burn_unitsstring · unit lot_quantity (per quantity_unit) · can be null
This day's units burned or recycled by a
netuidgroup (asunits;burn_cost_*is their value). Never negative (>= 0). Null on the whole set, anassetgroup orother(mixed_units), and on anetuidgroup where it is not computed yet (not_ready).- Format: whole number, as a string
- basis_tao_raostring · unit rao (÷1e9) · can be null
Cost basis of the set's holdings, TAO (rao). Never negative (>= 0). Null when unknown:
unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · on chain: u64
- basis_fiatstring · unit ccy · can be null
Cost basis, in the reporting currency. Never negative (>= 0). Null when unknown:
unavailable_reasonsnames why (never 0 for unknown).- value_tao_raostring · unit rao (÷1e9) · can be null
Value at the close, TAO (rao). Never negative (>= 0). Null when unknown:
unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · on chain: u64
- value_fiatstring · unit ccy · can be null
Value at the close, in the reporting currency. Never negative (>= 0). Null when unknown:
unavailable_reasonsnames why (never 0 for unknown).- unrealized_tao_raostring · unit rao (÷1e9) · can be null
Unrealized gain: value - basis (signed), TAO (rao). Null when unknown:
unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · can be negative
- unrealized_fiatstring · unit ccy · can be null
Unrealized gain: value - basis (signed), in the reporting currency. Null when unknown:
unavailable_reasonsnames why (never 0 for unknown).- can be negative
- realized_tao_raostring · unit rao (÷1e9) · can be null
Realized gain on this day's disposals (signed), TAO (rao). Only disposals of units whose cost is known: a leg taking units whose cost is unknown is left out and counted in
realized_unknown_legs(unknown is never 0). Null (not_ready) where it is not computed yet. Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · can be negative
- realized_unknown_legsinteger · unit count · can be null
How many disposal legs this day are left out of
realized_tao_raobecause the cost of the units they took is unknown: their gain is not in it. 0 when every cost is known. Null (not_ready) where it is not computed yet.- realized_fiatstring · unit ccy · can be null
Realized gain on this day's disposals (signed), in the reporting currency. Only disposals whose gain in the reporting currency is known: a leg taking units whose cost is unknown, or with no TAO to reporting-currency rate, is left out and counted in
realized_fiat_unknown_legs(unknown is never 0). Null (not_ready) where it is not computed yet. Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- can be negative
- realized_fiat_unknown_legsinteger · unit count · can be null
How many disposal legs this day are left out of
realized_fiatbecause their gain in the reporting currency is unknown (the cost of the units they took is unknown, or the TAO to reporting-currency rate is missing): their gain is not in it. Counted apart from the TAO legs: a missing rate leaves a leg out in the reporting currency only. 0 when every gain is known. Null (not_ready) where it is not computed yet.- realized_unknown_reasonstring · can be null
Why this day has disposal legs left out of its realized gain:
unvalued_units= a leg took units whose cost is unknown (left out in TAO and the reporting currency);rate_unknown= the TAO to reporting-currency rate is missing (left out in the reporting currency only). Null when the day has none (realized_unknown_legsandrealized_fiat_unknown_legs0) or where they are not computed yet (the counts null). New values may be added; treat unknown values as unavailable.- realized_cum_tao_raostring · unit rao (÷1e9) · can be null
Realized gain since the first acquisition, through this day (signed), TAO (rao). Only disposals of units whose cost is known: a leg taking units whose cost is unknown is left out and counted in
realized_cum_unknown_legs(unknown is never 0). Null (not_ready) where it is not computed yet. Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · can be negative
- realized_cum_unknown_legsinteger · unit count · can be null
How many disposal legs since the first acquisition, through this day, are left out of
realized_cum_tao_raobecause the cost of the units they took is unknown: their gain is not in it. 0 when every cost is known. Null (not_ready) where it is not computed yet.- realized_cum_fiatstring · unit ccy · can be null
Realized gain since the first acquisition, through this day (signed), in the reporting currency. Only disposals whose gain in the reporting currency is known: a leg taking units whose cost is unknown, or with no TAO to reporting-currency rate, is left out and counted in
realized_cum_fiat_unknown_legs(unknown is never 0). Null (not_ready) where it is not computed yet. Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- can be negative
- realized_cum_fiat_unknown_legsinteger · unit count · can be null
How many disposal legs since the first acquisition, through this day, are left out of
realized_cum_fiatbecause their gain in the reporting currency is unknown (the cost of the units they took is unknown, or the TAO to reporting-currency rate is missing): their gain is not in it. Counted apart from the TAO legs: a missing rate leaves a leg out in the reporting currency only. 0 when every gain is known. Null (not_ready) where it is not computed yet.- income_emission_tao_raostring · unit rao (÷1e9) · can be null
Subnet emission received this day, at receipt value, TAO (rao). Null when unknown:
unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · on chain: u64
- income_root_tao_raostring · unit rao (÷1e9) · can be null
Root dividends received this day, at receipt value, TAO (rao). Null when unknown:
unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · on chain: u64
- income_growth_tao_raostring · unit rao (÷1e9) · can be null
Pool growth of every pool held (subnet alpha pools and root). Only its root part (
income_root_growth_*) counts as income: growth of a subnet's alpha pool is value growth, already in the value and the unrealized gain, so it is not in the income totals. This day, at receipt value, TAO (rao). Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · on chain: u64
- income_root_growth_tao_raostring · unit rao (÷1e9) · can be null
Root pool growth: the growth of the root stake pool, the part of pool growth (
income_growth_*) that counts as income. 0 on every position outside root. Null (not_ready) where it is not computed yet. This day, at receipt value, TAO (rao). Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · on chain: u64
- income_swap_misallocation_tao_raostring · unit rao (÷1e9) · can be null
Hotkey-swap misallocation: value gained when a hotkey swap, before the chain changed swaps in March 2026 to move stake by value, combined two stake pools without repricing their shares, so value moved from one pool's stakers to the other's; counted as income at its value when received, less any part the chain later took back. 0 for nearly every account. Received this day (signed), at receipt value, TAO (rao). Negative on a day the chain took back an earlier misallocation gain. Null when unknown:
unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · can be negative
- income_fee_tao_raostring · unit rao (÷1e9) · can be null
Block-author fee share: the share of transaction fees paid to the block author, received to free TAO, income at its value when received (1 TAO for 1 TAO). On the TAO position only (asset
root; 0 elsewhere). Not a staking reward. Received this day, TAO (rao). Null when unknown:unavailable_reasonsnames why (never 0 for unknown). Null (not_ready) where it is not computed yet.- Format: whole number, as a string · on chain: u64
- income_owner_tao_raostring · unit rao (÷1e9) · can be null
Subnet-owner emission: emission paid to a subnet owner's free TAO before dynamic TAO, income at its value when received (1 TAO for 1 TAO). On the TAO position only (asset
root; 0 elsewhere). Not a staking reward. Received this day, TAO (rao). Null when unknown:unavailable_reasonsnames why (never 0 for unknown). Null (not_ready) where it is not computed yet.- Format: whole number, as a string · on chain: u64
- income_tao_raostring · unit rao (÷1e9) · can be null
All income this day (signed), TAO (rao): exactly subnet emission + root dividends + root pool growth + hotkey-swap misallocation + block-author fee share + subnet-owner emission (
income_emission_*+income_root_*+income_root_growth_*+income_swap_misallocation_*+income_fee_*+income_owner_*). Growth of subnet alpha pools is not income, so the total is not the sum of all the parts when an alpha pool grew. Whileincome_fee_*andincome_owner_*are null (not_ready: not computed yet), the total leaves them out. Negative on a day the chain took back an earlier misallocation gain. Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · can be negative
- income_emission_fiatstring · unit ccy · can be null
Subnet emission received this day, in the reporting currency. Valued at receipt (the TAO price at the receipt's minute, in the reporting currency at that day's rate). Null when unknown:
unavailable_reasonsnames why (never 0 for unknown).- income_root_fiatstring · unit ccy · can be null
Root dividends received this day, in the reporting currency. Valued at receipt (the TAO price at the receipt's minute, in the reporting currency at that day's rate). Null when unknown:
unavailable_reasonsnames why (never 0 for unknown).- income_growth_fiatstring · unit ccy · can be null
Pool growth of every pool held (subnet alpha pools and root). Only its root part (
income_root_growth_*) counts as income: growth of a subnet's alpha pool is value growth, already in the value and the unrealized gain, so it is not in the income totals. This day, in the reporting currency. Valued at receipt (the TAO price at the receipt's minute, in the reporting currency at that day's rate). Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- income_root_growth_fiatstring · unit ccy · can be null
Root pool growth: the growth of the root stake pool, the part of pool growth (
income_growth_*) that counts as income. 0 on every position outside root. Null (not_ready) where it is not computed yet. This day, in the reporting currency. Valued at receipt (the TAO price at the receipt's minute, in the reporting currency at that day's rate). Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- income_swap_misallocation_fiatstring · unit ccy · can be null
Hotkey-swap misallocation: value gained when a hotkey swap, before the chain changed swaps in March 2026 to move stake by value, combined two stake pools without repricing their shares, so value moved from one pool's stakers to the other's; counted as income at its value when received, less any part the chain later took back. 0 for nearly every account. Received this day (signed), in the reporting currency. Valued at receipt (the TAO price at the receipt's minute, in the reporting currency at that day's rate). Negative on a day the chain took back an earlier misallocation gain. Null when unknown:
unavailable_reasonsnames why (never 0 for unknown).- can be negative
- income_fee_fiatstring · unit ccy · can be null
Block-author fee share: the share of transaction fees paid to the block author, received to free TAO, income at its value when received (1 TAO for 1 TAO). On the TAO position only (asset
root; 0 elsewhere). Not a staking reward. Received this day, in the reporting currency. Valued at receipt (the TAO price at the receipt's minute, in the reporting currency at that day's rate). Null when unknown:unavailable_reasonsnames why (never 0 for unknown). Null (not_ready) where it is not computed yet.- income_owner_fiatstring · unit ccy · can be null
Subnet-owner emission: emission paid to a subnet owner's free TAO before dynamic TAO, income at its value when received (1 TAO for 1 TAO). On the TAO position only (asset
root; 0 elsewhere). Not a staking reward. Received this day, in the reporting currency. Valued at receipt (the TAO price at the receipt's minute, in the reporting currency at that day's rate). Null when unknown:unavailable_reasonsnames why (never 0 for unknown). Null (not_ready) where it is not computed yet.- income_fiatstring · unit ccy · can be null
All income this day (signed), in the reporting currency: exactly subnet emission + root dividends + root pool growth + hotkey-swap misallocation + block-author fee share + subnet-owner emission (
income_emission_*+income_root_*+income_root_growth_*+income_swap_misallocation_*+income_fee_*+income_owner_*). Growth of subnet alpha pools is not income, so the total is not the sum of all the parts when an alpha pool grew. Whileincome_fee_*andincome_owner_*are null (not_ready: not computed yet), the total leaves them out. Null when any of those parts is (other than a part not computed yet). Negative on a day the chain took back an earlier misallocation gain. Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- can be negative
- staking_rewards_tao_raostring · unit rao (÷1e9) · can be null
Staking rewards: what staking paid, exactly subnet emission + root dividends + pool growth (
income_emission_*+income_root_*+income_growth_*), pool growth being the rise in a validator pool's value per unit as rewards accrue to it (an accumulating fund). Price moves and hotkey-swap misallocation are not in it. Unlike the income totals (income_*, which follow the method inmeta.lens), it counts all pool growth, subnet alpha pools' included. This day, at receipt value, TAO (rao). Never negative: a take-back of hotkey-swap misallocation is not in it. Never includes the block-author fee share or subnet-owner emission (income_fee_*,income_owner_*). Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · on chain: u64
- staking_rewards_fiatstring · unit ccy · can be null
Staking rewards: what staking paid, exactly subnet emission + root dividends + pool growth (
income_emission_*+income_root_*+income_growth_*), pool growth being the rise in a validator pool's value per unit as rewards accrue to it (an accumulating fund). Price moves and hotkey-swap misallocation are not in it. Unlike the income totals (income_*, which follow the method inmeta.lens), it counts all pool growth, subnet alpha pools' included. This day, in the reporting currency. Valued at receipt (the TAO price at the receipt's minute, in the reporting currency at that day's rate). Null when any of those three parts is. Never includes the block-author fee share or subnet-owner emission (income_fee_*,income_owner_*). Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- income_alpha_growth_tao_raostring · unit rao (÷1e9) · can be null
Alpha pool growth: the subnet alpha pools' part of pool growth, exactly
income_growth_*-income_root_growth_*. Counted as appreciation, not income, under thefundmethod (meta.lens), so it is not in the income totals; it is instaking_rewards_*. 0 on root positions. Null (not_ready) where root pool growth is not computed yet. This day, at receipt value, TAO (rao). Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · on chain: u64
- income_alpha_growth_fiatstring · unit ccy · can be null
Alpha pool growth: the subnet alpha pools' part of pool growth, exactly
income_growth_*-income_root_growth_*. Counted as appreciation, not income, under thefundmethod (meta.lens), so it is not in the income totals; it is instaking_rewards_*. 0 on root positions. Null (not_ready) where root pool growth is not computed yet. This day, in the reporting currency. Valued at receipt (the TAO price at the receipt's minute, in the reporting currency at that day's rate). Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- external_in_tao_raostring · unit rao (÷1e9) · can be null
Value brought into the set from outside it this day, TAO (rao). Null when unknown:
unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · on chain: u64
- external_out_tao_raostring · unit rao (÷1e9) · can be null
Value taken out of the set this day, TAO (rao). Null when unknown:
unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · on chain: u64
- burn_cost_tao_raostring · unit rao (÷1e9) · can be null
Burn cost: units burned, an expense of their value. On the TAO position (asset
root): TAO burned (a burn, a registration or lock burn, a claim or escrow burn), 1 TAO for 1 TAO, in the reporting currency at the burn's minute. On an alpha position: the alpha burned or recycled, at its value at the burn's block. Each burn is also a disposal at the average basis, inside realized (P&L = gain - fee_cost_standalone - burn_cost). Spent this day, TAO (rao). Null when unknown:unavailable_reasonsnames why (never 0 for unknown). Null (not_ready) where it is not computed yet.- Format: whole number, as a string · on chain: u64
- burn_cost_fiatstring · unit ccy · can be null
Burn cost: units burned, an expense of their value. On the TAO position (asset
root): TAO burned (a burn, a registration or lock burn, a claim or escrow burn), 1 TAO for 1 TAO, in the reporting currency at the burn's minute. On an alpha position: the alpha burned or recycled, at its value at the burn's block. Each burn is also a disposal at the average basis, inside realized (P&L = gain - fee_cost_standalone - burn_cost). Spent this day, in the reporting currency. Null when unknown:unavailable_reasonsnames why (never 0 for unknown). Null (not_ready) where it is not computed yet.- fee_cost_standalone_tao_raostring · unit rao (÷1e9) · can be null
Standalone fee cost: on the TAO position (asset
root), the transaction fees paid in TAO (the transaction fee and EVM gas) netted per UTC day and booked when the day closes, at the day's mean TAO price in the reporting currency, plus EVM fee events at their minute; on an alpha position, the transaction fees paid in its alpha, at their value. An expense of its value, each also a disposal at the average basis, inside realized (P&L = gain - fee_cost_standalone - burn_cost). A swap's fee inside its proceeds is not a standalone fee and is not here. Spent this day, TAO (rao). Null when unknown:unavailable_reasonsnames why (never 0 for unknown). Null (not_ready) where it is not computed yet.- Format: whole number, as a string · on chain: u64
- fee_cost_standalone_fiatstring · unit ccy · can be null
Standalone fee cost: on the TAO position (asset
root), the transaction fees paid in TAO (the transaction fee and EVM gas) netted per UTC day and booked when the day closes, at the day's mean TAO price in the reporting currency, plus EVM fee events at their minute; on an alpha position, the transaction fees paid in its alpha, at their value. An expense of its value, each also a disposal at the average basis, inside realized (P&L = gain - fee_cost_standalone - burn_cost). A swap's fee inside its proceeds is not a standalone fee and is not here. Spent this day, in the reporting currency. Null when unknown:unavailable_reasonsnames why (never 0 for unknown). Null (not_ready) where it is not computed yet.- claims_receivable_tao_raostring · unit rao (÷1e9)
The open dissolution receivable: TAO that a removed subnet's pool still owes the account, between the subnet's removal (when the position in it was disposed of) and the payouts, held at its TAO amount (1 TAO = 1 TAO). It is part of the
tao_claimsposition's units, not in addition to them: the account's TAO isroot+tao_free+tao_claims, and this is the part oftao_claimsstill to be paid. When a payout lands, its amount moves totao_free. 0 on every other position, and when nothing is owed. Always present, never absent: 0 while this figure is not yet computed: the ended position's alpha then stays held until the payouts arrive astao_free. At this day's close, summed over the row's positions (non-zero only on a row that can include atao_claimsposition: the set,other, netuid 0's group or thetao_claimsgroup); insidevalue_tao_rao, never to be added to it. Never null.- Format: whole number, as a string · on chain: u64
- price_effect_tao_raostring · unit rao (÷1e9) · can be null
This day's change in value from price moves on units held (signed), TAO (rao). Income of every kind (hotkey-swap misallocation included) is a flow in, not part of it. Burns and standalone fees count as flows out, as sells and fees do: their value (
burn_cost_*,fee_cost_standalone_*) is added back, so a burn or fee is not a price move. Null (flows_unvalued) when a burn or standalone fee that day has no value. Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- Format: whole number, as a string · can be negative
- price_effect_fiatstring · unit ccy · can be null
This day's change in value from price moves on units held (signed), in the reporting currency:
fx_effect_fiat+market_effect_fiat. Burns and standalone fees count as flows out, as sells and fees do: their value (burn_cost_*,fee_cost_standalone_*) is added back, so a burn or fee is not a price move. Null withrate_unknownwhen the TAO price effect is known but an exchange rate the day needs is missing, orflows_unvaluedwhen the TAO price effect is unknown. Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- can be negative
- fx_effect_fiatstring · unit ccy · can be null
Of the day's price effect in the reporting currency, the part the exchange-rate move made on the day before's holdings (0 in USD). Null with
price_effect_fiat. Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- can be negative
- market_effect_fiatstring · unit ccy · can be null
Of the day's price effect in the reporting currency, the part TAO and alpha prices made (
price_effect_fiat-fx_effect_fiat). Null withprice_effect_fiat. Null when unknown:unavailable_reasonsnames why (never 0 for unknown).- can be negative
- positionsinteger · unit count
Positions the set held at the day's close.
- unknown_basis_positionsinteger · unit count
Of
positions, those that had units leave without a proven counterpart (unknown_basis_unitson the position). Informational: no figure is unknown because of it.- unvalued_positionsinteger · unit count
Of
positions, those with units that entered at no known cost (unvalued: the basis is unknown).- price_unknown_positionsinteger · unit count
Of
positions, those without a close price that day (price_unknown).- internal_transfer_basis_approxboolean
True when the set holds several accounts: each account's basis is summed, so a move between them counts as value out of one and into the other, at an approximate cost.
- basis_estimatedboolean
True when a position held at the day's close has an estimated basis: units received from another account at their fair value at receipt. The basis stays known.
Response headers
6 headers: Cache-Control, RateLimit-Policy, RateLimit, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
- 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).- 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 · 400 · 401 · 402 · 403 · 404 · 429 · 500 · 502 · 503
Error codes
The codes this endpoint can return. Each links to what it means and what to do.
- ADDRESSES_REQUIRED
- ADDRESS_NOT_IN_PLAN_SCOPE
- AMBIGUOUS_CREDENTIALS
- BAD_GATEWAY
- BATCH_TOO_LARGE
- BILLING_UNAVAILABLE
- BUDGET_EXCEEDED
- CONCURRENCY_LIMIT
- INSUFFICIENT_PERMISSIONS
- INTERNAL_ERROR
- INVALID_ADDRESS
- INVALID_ASSET
- INVALID_CURRENCY
- INVALID_DAY
- INVALID_GROUP_BY
- INVALID_GROUP_LIMIT
- INVALID_NETUID
- INVALID_PARAMETER
- INVALID_RANGE
- NOT_READY
- PAYMENT_REQUIRED
- PLAN_REQUIRED
- RANGE_TOO_LARGE
- RATE_LIMITED
- SERVICE_UNAVAILABLE
- SOURCE_BUSY
- SOURCE_NOT_READY
- SOURCE_TIMEOUT
- UNAUTHORIZED
- UNKNOWN_PARAMETER
- VALIDATION_ERROR
From the API's published specification, version 1.165.0.