Skip to content
TAO$188.21
BTC0.002927
MCap$2.22B
Vol$86.25M

API reference / Address labels

An account's label and its entity

GET/api/v2/labels/{address}
Status
Stable
Auth
API key or OAuth access token
Scope
data:read
Rate limit
plan

The account's label and the entity it names (/api/v2/entities/{entity_id}), {address: {ss58, hex}, label, entity}; both null for an account without a label. 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: INVALID_ADDRESS, UNKNOWN_PARAMETER, SOURCE_TIMEOUT (503), SOURCE_NOT_READY (503).

Path parameters

addresspath, required· string

The account: SS58, or 0x + 64 hex.

Query parameters

includequery· string

Reserved for opt-in sections. This route defines none yet; the parameter is declared so that adding one later is additive for generated clients. Any value is a 400 INVALID_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 account, its label and the entity.

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
labelobject · can be null

Its label; null for an account without one.

7 fields in label
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 the label names (/api/v2/entities/{id}; may contain /); null when none.

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]+$
entityobject · can be null

The entity the label names (label.entity_id); null without a label or an entity.

6 fields in entity
idstring

The entity's id, stable across runs (may contain /, e.g. pallet-bt/cloan).

namestring

Its display name.

kindstring

Its kind: exchange, validator, pallet, ... (an open set).

urlstring · can be null

Its website; null when none.

descriptionstring · can be null

A short plain-text description; null when none.

member_countinteger · unit count

How many accounts carry a label naming it.

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.