Skip to content
TAO$188.31
BTC0.002929
MCap$2.21B
Vol$86.07M

API reference / Accounts

On-chain identities of up to 100 accounts (POST)

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

The current on-chain identity (SubtensorModule IdentitiesV2: name, url, GitHub repository, image, Discord, description, additional, and whether every field decoded) of several accounts, one item per requested address in request order, {address: {ss58, hex}, identity} (identity null for an account without one), all read at the head (meta.at). The body is {addresses} with up to 100 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..100. Answered in this order; a duplicate is answered as given. An empty list is a 400 ADDRESSES_REQUIRED, more than 100 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
identityobject · can be null

Its on-chain identity now (SubtensorModule IdentitiesV2); for a hotkey without one of its own, its Owner coldkey's (via_owner true). Null when neither has one.

9 fields in identity
namestring · can be null

The display name. As the owner set it (UTF-8; "" when left empty); null when the stored bytes are not valid UTF-8 (decoded false).

urlstring · can be null

The website. As the owner set it (UTF-8; "" when left empty); null when the stored bytes are not valid UTF-8 (decoded false).

github_repostring · can be null

The GitHub repository. As the owner set it (UTF-8; "" when left empty); null when the stored bytes are not valid UTF-8 (decoded false).

imagestring · can be null

The identity's image: our copy of the image (fetched, checked and re-encoded by bittensor.ai), never the URL set on chain. Null when we hold no copy: image_unavailable_reason says why.

discordstring · can be null

The Discord handle. As the owner set it (UTF-8; "" when left empty); null when the stored bytes are not valid UTF-8 (decoded false).

descriptionstring · can be null

A free-text description. As the owner set it (UTF-8; "" when left empty); null when the stored bytes are not valid UTF-8 (decoded false).

additionalstring · can be null

Any additional text. As the owner set it (UTF-8; "" when left empty); null when the stored bytes are not valid UTF-8 (decoded false).

image_unavailable_reasonstring · can be null

Why image is null: none_set (no image is set on chain), not_mirrored_yet (one is set and we hold no copy of it yet), fetch_failed (our last fetch of it failed: not found, refused, unreachable, or not a usable https URL) or unsafe_content (what it points at was refused: not an allowed image type, invalid or too large). Null exactly when image is served. New values may be added; treat unknown values as unavailable.

decodedboolean

True when every stored field is valid UTF-8; false when one is not (that field is then null).

via_ownerboolean

True when identity is the Owner coldkey's, not the address's own (the address is a hotkey without an identity of its own).

owner_coldkeystring · can be null

The coldkey that owns the address (SubtensorModule.Owner), SS58, when the address is a hotkey; null otherwise.

Format: SS58 address

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.