The events of a basket fund
https://api.bittensor.ai/api/v2/baskets/{hotkey}/events- Status
- Beta
- Auth
- API key or OAuth access token
- Scope
data:read- Rate limit
plan
A validator's basket fund activity on its hotkey, newest first: BasketDeposited, BasketClaimed, BasketSwapped, BasketClaimDustSkipped, BasketStakedIn, BasketAlphaWrittenOff and BasketHoldingConverted (there is no redemption event: redemptions settle through claims), each in the /events row shape (args named, accounts SS58). Keyset-paged by meta.page.next_cursor (no total; a page can be short, even empty, with a next_cursor when the 20,000-candidate scan budget cut it: meta.page.scan_limited). This is how /baskets/{hotkey}?include=events continues (call with limit=<child_limit>). kind narrows to some of the seven, coldkey to one holder's claims and stake-ins. Errors are application/problem+json: INVALID_ADDRESS, INVALID_KIND, INVALID_RANGE, INVALID_LIMIT, INVALID_CURSOR, INVALID_INCLUDE, 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).
Path parameters
- hotkeypath, required· string
The validator's hotkey: SS58, or 0x + 64 hex.
Query parameters
- from_heightquery· integer · 0 to 2147483647
Only rows at or above this height (inclusive).
- to_heightquery· integer · 0 to 2147483647
Only rows at or below this height (inclusive).
- limitquery· integer · default 50 · 1 to 1000
Page size, 1..1000 (default 50).
- 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.- 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.- kindquery· array of string
Only these events:
deposited(BasketDeposited),claimed(BasketClaimed),swapped(BasketSwapped),claim_dust_skipped(BasketClaimDustSkipped),staked_in(BasketStakedIn: a staker paid TAO into the fund for units),written_off(BasketAlphaWrittenOff: an untradeable alpha slice burned),converted(BasketHoldingConverted: a dissolving subnet's holding moved to the fund's root slot); repeat for several (OR). Default: all seven. Anything else is a 400. While the last three are not available yet, a request naming one fails (SOURCE_NOT_READY).- coldkeyquery· string
Only this holder's events (the BasketClaimed / BasketClaimDustSkipped / BasketStakedIn naming it): SS58, or 0x + 64 hex. With
kind, the holder kinds among those asked (claimed,claim_dust_skipped,staked_in); akindwithout a holder kind is a 400INVALID_KIND.
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.
Events in order by (height, index). Can be shorter than limit, even empty, with a non-null meta.page.next_cursor (meta.page.scan_limited).
- idstring · unit id
The event's id,
{height}-{index}(index = its position in the block's System.Events).- Format: block and index, such as 4200000-3
- heightinteger · unit block
The block it was emitted in.
- indexinteger · unit id
Its index in the block's System.Events (0-based).
- timestring (date-time) · can be null
The block's Timestamp.set (RFC 3339 UTC, milliseconds). Null for block 0 only.
- Format: date and time, ISO 8601 in UTC
- phasestring
When it was emitted:
initialization(block hooks before the extrinsics, e.g. emission),extrinsic(while applying an extrinsic) orfinalization(block hooks after them; none after block 9,155,260). New values may be added; show an unknown value as is (or generically).- extrinsic_idstring · unit id · can be null
The extrinsic it was emitted under (
{height}-{index}); null in theinitializationandfinalizationphases.- Format: block and index, such as 4200000-3
- dispatch_phasestring · can be null
Where in applying its extrinsic the event was emitted, from the chain's per-event trace:
pre_dispatch(before the call ran: the fee withdraw),dispatch(by the call or the calls it dispatched) orpost_dispatch(after it: the fee refund, TransactionFeePaid, System.ExtrinsicSuccess / ExtrinsicFailed). Null outside theextrinsicphase, and below block 7,089,968 (before the trace covers). New values may be added; show an unknown value as is (or generically).- call_idstring · unit id · can be null
The call that emitted it (a call id). Null outside a dispatched call: the block phases, and the extrinsic's pre- and post-dispatch events (
dispatch_phasepre_dispatch/post_dispatch: the fee withdraw, the refund, TransactionFeePaid, ExtrinsicSuccess / ExtrinsicFailed), which no call emits, so per-call event lists and counts never include them. Below block 7,089,968 (dispatch_phasenull) the attribution is the event dictionary's, which puts a wrapper's pre-dispatch events on its first child.- Pattern:
^[0-9]+-[0-9]+(\.[0-9]+)*$ - eventobject
The event's kind.
2 fields in event
- palletstring
The pallet, as in the runtime metadata (e.g.
SubtensorModule).- namestring
The event, as in the runtime metadata (PascalCase, e.g.
StakeAdded).
- argsobject · can be null
The arguments as named fields, served exactly as the data source renders them (never re-rendered here). Names: the block's runtime metadata names each field (snake_case); unnamed tuple fields take their names from a reviewed list of override names (each entry traced to the subtensor source), else the snake_case of the field's type name (
_2,_3when repeated), elsearg0,arg1. A field typedNetUidStorageIndexis alwaysnetuid_index(= mechanism × 4096 + netuid), never a netuid. Values: accounts (AccountId32 by metadata type) are SS58; amounts are decimal strings in their base unit; enums are{__kind, value}; hashes and bytes are 0x hex; a nested call (batch, proxy, sudo) is{pallet, name, args}. The naming rule and the override names are versioned inmeta.data_version(args/<rule>.<overrides>), so a renamed field is a new version. Free-form: the members depend on the kind and the runtime, so this schema does not list them. Null only when the source stored no arguments.- error_palletstring · can be null
The DispatchError this event carries, decoded with the block's runtime: for a module error the pallet that raised it (e.g.
Swap), as an extrinsic'serror.pallet. Carried by System.ExtrinsicFailed, Utility.BatchInterrupted / ItemFailed, and theErrresults of Proxy.ProxyExecuted, Multisig.MultisigExecuted, Sudo.Sudid / SudoAsDone, Utility.DispatchedAs and Scheduler.Dispatched. Null on every other event, on anOkresult, for a non-module error (BadOrigin,Token, ...) and when the error could not be decoded.- error_namestring · can be null
The DispatchError's name, as an extrinsic's
error.name: a module error's (e.g.PriceLimitExceeded,HotKeyAlreadyRegisteredInSubNet), or the inner variant of aToken/Arithmetic/Transactionalerror (error_palletthen null). Null when the event carries no DispatchError, or it has no name (BadOrigin, an undecoded error).
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
- BAD_GATEWAY
- BILLING_UNAVAILABLE
- BUDGET_EXCEEDED
- CONCURRENCY_LIMIT
- INSUFFICIENT_PERMISSIONS
- INTERNAL_ERROR
- INVALID_ADDRESS
- INVALID_CURSOR
- INVALID_HEIGHT
- INVALID_INCLUDE
- INVALID_KIND
- INVALID_LIMIT
- INVALID_RANGE
- PAYMENT_REQUIRED
- PLAN_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.