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

API reference / Address labels

Labels of up to 1000 accounts (POST)

POST/api/v2/labels/batch
Status
Stable
Auth
API key or OAuth access token
Scope
data:read
Rate limit
plan

The labels of several accounts, one item per requested address in request order, {address: {ss58, hex}, label} (label null for an account without one). 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). The body is {addresses} with up to 1000 addresses; the answer is not cached (no-store). Errors are application/problem+json: ADDRESSES_REQUIRED, BATCH_TOO_LARGE, INVALID_ADDRESS (each invalid entry named by its index), UNKNOWN_PARAMETER, SOURCE_TIMEOUT (503), SOURCE_NOT_READY (503).

Request body

A JSON object with these fields:

addressesarray of string

The accounts, SS58 or 0x + 64 hex, 1..1000. Answered in this order; a duplicate is answered as given. An empty list is a 400 ADDRESSES_REQUIRED, more than 1000 a 400 BATCH_TOO_LARGE, an invalid one a 400 INVALID_ADDRESS naming its index (addresses[i]); the batch is atomic.

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.

One item per requested address, in request order (a duplicate is answered as given).

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]+$

Response headers

6 headers: Cache-Control, RateLimit-Policy, RateLimit, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
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).

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 · 400 · 401 · 402 · 403 · 404 · 429 · 500 · 502 · 503

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.