API reference / Address labels
The labelled accounts of an entity
https://api.bittensor.ai/api/v2/entities/{entity_id}/members- Status
- Stable
- Auth
- API key or OAuth access token
- Scope
data:read- Rate limit
plan
The accounts whose label names the entity, by address, keyset-paged: each row is the account ({ss58, hex}) and its label's members. inferred=false keeps only the accounts labelled directly, inferred=true only the inferred ones (meta.inferred echoes the filter, null without it); meta.total counts every account that matches, on every page. Labels are off-chain attributions, never chain facts: most are inferred (inferred true: show them as likely). Where a label came from is not disclosed. The labels are refreshed nightly; the answer is cached until the next run (meta.labels_next_run, at most 24 h). Errors are application/problem+json: NOT_FOUND (404, no such entity), INVALID_LIMIT, INVALID_CURSOR, INVALID_BOOLEAN, UNKNOWN_PARAMETER, SOURCE_TIMEOUT (503), SOURCE_NOT_READY (503).
Path parameters
- entity_idpath, required· string
The entity's id (
label.entity_id), e.g.exchange-binance. It may contain/(pallet-bt/cloan): send it as is or URL-encoded (pallet-bt%2Fcloan).
Query parameters
- limitquery· integer · default 100 · 1 to 1000
Page size, 1..1000 (default 100).
- 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.- inferredquery· enum · one of true, false
Only the accounts labelled directly (
false) or only the inferred ones (true); omitted: every account. A cursor continues the filter it was issued under: send the same value.trueorfalse(lower-case; anything else is a 400INVALID_BOOLEAN).
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.
The page's accounts, by address (hex) ascending.
- addressobject
The account, as
{ss58, hex}.2 fields in address
- 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
- labelstring
The display name of the labelled account (e.g.
Binance).- sublabelstring · can be null
A finer role within the entity (e.g.
deposit,hot wallet); null when none.- entity_idstring · can be null
The entity asked for.
- entity_kindstring · can be null
The entity's kind:
exchange,validator,pallet, ... (an open set); null when none.- inferredboolean
True when the label is attributed by a heuristic (most labels): show it as likely, never as a fact.
- verifiedboolean
True when the label is confirmed on chain or by the entity itself.
- confidencestring · unit ratio · can be null
How sure the attribution is, a decimal string 0..1 (e.g.
0.95); null when not scored.- Pattern:
^[0-9]\.[0-9]+$
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_BOOLEAN
- INVALID_CURSOR
- INVALID_LIMIT
- NOT_FOUND
- PAYMENT_REQUIRED
- PLAN_LIMIT_EXCEEDED
- 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.