Skip to content
TAO$188.36
BTC0.002929
MCap$2.22B
Vol$86.25M

API reference / Subnets

A subnet life's commitment figures, by pointer kind

GET/api/v2/subnets/{netuid}/commitments/summary
Status
Beta
Auth
API key or OAuth access token
Scope
data:read
Rate limit
plan

How many current commitments were set during the life, how many could not be decoded, and how many typed pointers they hold, in total and per kind. Typed pointers decoded from hotkeys' current on-chain commitments (Commitments.set_commitment): Hugging Face models and datasets, GitHub repositories and gists, URLs, IPFS content ids, buckets, commit ids, content hashes, JSON, opaque text, timelocked fields (never decrypted). Nothing a pointer names is fetched. Unknown is never 0: until every current commitment of the life has been read (status complete), every figure is null with reason (not_read_yet, read_incomplete); a complete 0 is a real zero. Life: the slot's current life (the head subnet directory's generation), or the one generation names (an ended subnet's own page). Everything is keyed by the life: a re-registered slot never shows the previous subnet's website. Cached 5 minutes (slow class), an ended life's answer 1 hour. Errors are application/problem+json: INVALID_NETUID, SUBNET_NOT_FOUND (404: no subnet is registered in the slot at the head; with generation, the slot was never registered), INVALID_GENERATION (400), GENERATION_NOT_FOUND (404), UNKNOWN_PARAMETER, SOURCE_TIMEOUT (503), SERVICE_UNAVAILABLE (503), SOURCE_NOT_READY (503: commitments are not served on this deployment yet).

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

Path parameters

netuidpath, required· integer · 0 to 65535

Subnet slot (0 = root).

Query parameters

generationquery· integer · at least 0

The subnet life to serve: its generation as GET /api/v2/subnets/generations names it, or its start_height; the id is matched first, and data.generation / meta.generation is always the canonical id. Omitted: the slot's current life. Neither of a life of the slot: a 404 GENERATION_NOT_FOUND; not an integer >= 0: a 400 INVALID_GENERATION.

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 life's figures (null figures unless complete).

netuidinteger · unit id

Subnet slot (0 = root).

generationinteger · unit id · can be null

Opaque life id (the life's registration identifier), NOT a block height; use life_start_height for the first block. The subnet life the figures cover.

life_start_heightinteger · unit block · can be null

The first block of the life generation names (GET /subnets/generations' start_height): use it, never generation, for heights, ages and dates. Null exactly when generation is null (root without a life, no subnet), or transiently when this API cannot read the lives. Root's generation 0 starts at 0.

is_current_lifeboolean · can be null

Whether generation is the slot's current life (true) or an ended one, re-registered since (false). Null exactly when generation is null, or transiently when this API cannot read the lives. Root's generation 0 is current.

statusstring

complete (every current commitment of the life was read: the figures are set) or unknown (see reason: every figure is null). New values may be added; show an unknown value as is (or generically).

reasonstring · can be null

Why the figures are null; null when status is complete: not_read_yet (the life's commitments have not been read yet), read_incomplete (the last full read stopped early). New values may be added; treat unknown values as unavailable.

commitmentsinteger · unit count · can be null

Current commitments set during this life (one per hotkey). Null unless status is complete (unknown is never 0); a complete 0 is a real zero.

undecodableinteger · unit count · can be null

Of those, values that could not be decoded. Null unless status is complete (unknown is never 0); a complete 0 is a real zero.

pointersinteger · unit count · can be null

Typed pointers in them, those whose URL is assessed malicious included (a count, not a list). Null unless status is complete (unknown is never 0); a complete 0 is a real zero.

hf_modelinteger · unit count · can be null

Pointers that are a Hugging Face model id (owner/name[@revision]). Null unless status is complete (unknown is never 0); a complete 0 is a real zero.

hf_datasetinteger · unit count · can be null

Pointers that are a Hugging Face dataset id. Null unless status is complete (unknown is never 0); a complete 0 is a real zero.

github_repointeger · unit count · can be null

Pointers that are a GitHub repository URL. Null unless status is complete (unknown is never 0); a complete 0 is a real zero.

gistinteger · unit count · can be null

Pointers that are a GitHub gist URL. Null unless status is complete (unknown is never 0); a complete 0 is a real zero.

urlinteger · unit count · can be null

Pointers that are any other http(s) URL. Null unless status is complete (unknown is never 0); a complete 0 is a real zero.

ipfs_cidinteger · unit count · can be null

Pointers that are an IPFS content id. Null unless status is complete (unknown is never 0); a complete 0 is a real zero.

r2_or_s3_bucketinteger · unit count · can be null

Pointers that are an object-storage bucket. Null unless status is complete (unknown is never 0); a complete 0 is a real zero.

commit_shainteger · unit count · can be null

Pointers that are a 40-hex commit id. Null unless status is complete (unknown is never 0); a complete 0 is a real zero.

content_hashinteger · unit count · can be null

Pointers that are a content hash (sha256, blake2_256, keccak_256, sha3_256 or bare hex). Null unless status is complete (unknown is never 0); a complete 0 is a real zero.

jsoninteger · unit count · can be null

Pointers that are a JSON object with no recognised pointer (wire name json). Null unless status is complete (unknown is never 0); a complete 0 is a real zero.

opaqueinteger · unit count · can be null

Pointers that are text or bytes with no recognised pointer. Null unless status is complete (unknown is never 0); a complete 0 is a real zero.

timelockedinteger · unit count · can be null

Pointers that are a timelock-encrypted field (never decrypted). Null unless status is complete (unknown is never 0); a complete 0 is a real zero.

changed_atstring (date-time) · can be null

When a figure last changed, RFC 3339 UTC; null when the life has not been read yet.

Format: date and time, ISO 8601 in UTC
as_ofstring (date-time) · can be null

The last complete read the figures reflect, RFC 3339 UTC; null when the life has not been read yet.

Format: date and time, ISO 8601 in UTC

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.