The basket escrow against what its funds owe their holders, at a day close
https://api.bittensor.ai/api/v2/baskets/escrow-attribution- Status
- Beta
- Auth
- API key or OAuth access token
- Scope
data:read- Rate limit
plan
The basket escrow (the module account every v441 fund's root stakers are paid from) at one UTC day close: its stake at spot, the stake its funds' holders are owed (each (fund, holder) pair's owed units, the runtime's claim cap, x its fund's spot NAV per unit at the same close; attributed_spot_tao_rao) and the difference (unattributed_spot_tao_rao: escrow stake no holder is owed; negative when they are owed more than it holds). Null, never partial, when any pair's fund has no NAV that day (unpriced_pairs). include=funds adds the per-fund rows. at is a UTC day (default: the newest available). An explicit day is cached as settled once its close is final; the default day moves with the newest available day (slow). Errors are application/problem+json: INVALID_AT, AT_OUT_OF_COVERAGE, INVALID_INCLUDE, NOT_READY (503: no day is available yet), 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,
YYYY-MM-DD(its close). Default: the newest available day. Anything else is a 400INVALID_AT; a day outside the available days a 400AT_OUT_OF_COVERAGE.- Format: date, YYYY-MM-DD
- includequery· string
funds: adddata.by_fund, one row per fund (holders, owed units, NAV, attributed TAO). Anything else is a 400INVALID_INCLUDE.
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 escrow, the attribution and (with include=funds) the funds.
- daystring (date)
The UTC day.
- Format: date, YYYY-MM-DD
- heightinteger · unit block
Its close: the day's last block (
meta.at).- escrowstring
The basket escrow account (the module account
modlsubtensrbeta/esc), SS58.- Format: SS58 address
- escrow_spot_tao_raostring · unit rao (÷1e9) · can be null
The escrow's value at the close as
/accounts/{address}serves it (total_spot_tao_rao: its positions at spot), rao of TAO. Null when not known.- Format: whole number, as a string · on chain: u64
- attributed_spot_tao_raostring · unit rao (÷1e9) · can be null
Every (fund, holder) pair's owed units x its fund's spot NAV per unit at the same close, summed then floored, rao of TAO: the stake the escrow holds for the funds' holders. Null when any pair is unpriced (
unpriced_pairs> 0): never a partial sum.- Format: whole number, as a string · on chain: u64
- unattributed_spot_tao_raostring · unit rao (÷1e9) · can be null
escrow_spot_tao_rao-attributed_spot_tao_rao(checked): escrow stake no holder is owed, rao of TAO; negative when the holders are owed more than it holds (served as is). Null with either operand.- Format: whole number, as a string · can be negative
- fundsinteger · unit count
Funds with holders owed units at the close.
- attributed_pairsinteger · unit count
(fund, holder) pairs valued.
- unpriced_pairsinteger · unit count
Pairs whose fund has no NAV per unit at the close (0 = every pair valued).
- by_fundarray of objects · optional
Only with
include=funds(absent otherwise): one row per fund, largest attributed first, the unpriced last; their holders sum to the pairs.6 fields in by_fund (each item)
- hotkeystring
The fund's validator hotkey, SS58 (prefix 42).
- Format: SS58 address
- holdersinteger · unit count
Its holders owed units at the day close.
- owed_unitsstring · unit count
The units its holders are owed (the runtime's claim cap), summed: fund units, not TAO.
- Format: whole number, as a string
- unitsstring · unit count · can be null
The fund's units outstanding at the close. Null when it has no NAV row there.
- Format: whole number, as a string
- attributed_spot_tao_raostring · unit rao (÷1e9) · can be null
owed_unitsx the fund's spot NAV per unit, floored, rao of TAO: what the escrow holds for its holders. Null when the fund has no NAV per unit (its pairs areunpriced_pairs).- Format: whole number, as a string · on chain: u64
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.
- AMBIGUOUS_CREDENTIALS
- AT_OUT_OF_COVERAGE
- BAD_GATEWAY
- BILLING_UNAVAILABLE
- BUDGET_EXCEEDED
- CONCURRENCY_LIMIT
- INSUFFICIENT_PERMISSIONS
- INTERNAL_ERROR
- INVALID_AT
- INVALID_INCLUDE
- NOT_READY
- PAYMENT_REQUIRED
- PLAN_REQUIRED
- 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.