API reference / Address labels
The label to show for up to 500 addresses (POST)
https://api.bittensor.ai/api/v2/address-labels/batch- Status
- Beta
- Auth
- API key or OAuth access token
- Scope
data:read- Rate limit
plan
The label to show beside each address, one item per requested address in request order, {address, chain, label}: its text, its role and, for a label the address's owner added by proving control with a signature, is_self_described (the owner's own description, not checked by bittensor.ai) and claimed_via; a heuristic label carries is_inferred (show it as likely). When an address has several labels, bittensor.ai picks one; where a label came from is not disclosed. SS58 accounts (or their 0x + 64 hex keys) and 0x H160 addresses (any letter case) alike. Labels are off-chain annotations, never chain facts. The body is {addresses} with up to 500 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).
Beta: this route may change with one release's notice in the v2 changelog; additive changes need none (x-stability: beta).
Request body
A JSON object with these fields:
- addressesarray of string
The addresses, SS58 (or 0x + 64 hex) or 0x H160 (any letter case), 1..500, answered in this order. An empty list is a 400
ADDRESSES_REQUIRED, more than 500 a 400BATCH_TOO_LARGE, an invalid one a 400INVALID_ADDRESSnaming 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).
- addressstring
The address in its canonical spelling: SS58 (prefix 42), or an H160 as its EIP-55 checksum.
- chainenum
bittensor(an SS58 account) orbittensor_evm(a 0x H160 address).- One of:
bittensor,bittensor_evm - labelobject · can be null
Its label; null when none is known.
7 fields in label
- textstring
The label's text, plain text: render it as text (never as HTML), beside the address, never in its place.
- rolestring · can be null
What the address is, from a closed list (
fee_wallet,treasury_personal,treasury_organisation,bridge,bridge_custody,exchange_hot,exchange_cold,exchange_deposit,validator_operations,subnet_owner_operations,multisig_signer_set,contract_admin,airdrop_distributor,burn,team_vesting,market_maker,other). Null on a label that names an entity instead. New values may be added; show an unknown value as is (or generically).- is_self_describedboolean
True when the label was added by the address's owner, who proved control of the address by signature: the content is the owner's own description, not checked by bittensor.ai. Show it as "self-described" or "added by owner" ("added by the deployer" when
claimed_viaisdeployer), never as verified or accurate. False for every other label.- claimed_viaenum · can be null
With
is_self_described: who signed.address: the address's own key ("added by owner");deployer: the account that deployed the contract ("added by the deployer"). Null on every other label.- One of:
address,deployer - is_inferredboolean
True when the label is a heuristic attribution: show it as likely, never as a fact. False for every other label.
- entity_idstring · can be null
The entity the label names (
/api/v2/entities/{id}); null when it names none.- entity_kindstring · can be null
That entity's kind (
exchange,validator, ...: an open set); null when it names none.
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), 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).- 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.
- ADDRESSES_REQUIRED
- AMBIGUOUS_CREDENTIALS
- BAD_GATEWAY
- BATCH_TOO_LARGE
- BILLING_UNAVAILABLE
- BUDGET_EXCEEDED
- CONCURRENCY_LIMIT
- INSUFFICIENT_PERMISSIONS
- INTERNAL_ERROR
- INVALID_ADDRESS
- INVALID_PARAMETER
- PAYMENT_REQUIRED
- PLAN_REQUIRED
- RATE_LIMITED
- SERVICE_UNAVAILABLE
- SOURCE_BUSY
- SOURCE_NOT_READY
- SOURCE_TIMEOUT
- UNAUTHORIZED
- UNKNOWN_PARAMETER
- VALIDATION_ERROR
From the API's published specification, version 1.165.0.