Skip to content
TAO$188.40
BTC0.00293
MCap$2.21B
Vol$86.07M

API reference / Address labels

Check an address-to-domain link

GET/api/v2/address-names/check
Status
Beta
Auth
API key or OAuth access token
Scope
data:read
Rate limit
plan

Checks now whether an address and a domain vouch for each other. Domain side (fetched live, cached 60 s per domain): https://<domain>/.well-known/bittensor-addresses.json = {"version":1,"entity":"<name>","addresses":[{"address":"<SS58|H160>","role":"<role>"}]}, or a DNS TXT record at _bittensor.<domain> = v=1; address=<addr>; role=<role> (one record per address). Only public HTTPS on port 443 is fetched, with same-host redirects, a 5 s timeout and a 64 KB cap. Key side (from the chain): the account's current on-chain identity URL is the domain, or the address submitted System.remark_with_event with the exact text bittensor domain v1 <domain> (bittensor.ai prepares it as a signing request for the wallet to sign); a newer bittensor domain v1 remove <domain> remark withdraws it. level is two_way when both hold. role is the domain's declared role; when the address also has a published signed label with another role, role_mismatch says so. accounting_status is fee accounting as this check sees it now (computed on each call; nothing is recorded). missing lists the remaining steps as text to show. Not cached (no-store). Errors are application/problem+json: INVALID_ADDRESS, INVALID_DOMAIN, UNKNOWN_PARAMETER, VALIDATION_ERROR, RATE_LIMITED (429, at most 20 checks per minute per client IP, with Retry-After).

Beta: this route may change with one release's notice in the v2 changelog; additive changes need none (x-stability: beta).

Query parameters

addressquery, required· string

The address: SS58 (or its 0x + 64 hex key) or a 0x H160. Invalid: 400 INVALID_ADDRESS.

domainquery, required· string

The domain, e.g. example.com (a scheme, path or port is removed; an internationalised name is converted to punycode). Not a public host name: 400 INVALID_DOMAIN.

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 check's result.

addressstring

The address in its canonical spelling: SS58 (prefix 42), or an H160 as its EIP-55 checksum.

domainstring

The domain as checked: lower case, scheme, path and port removed, an internationalised name as punycode.

levelstring

two_way when both sides vouch for each other, domain_only / key_only when one does, none when neither. New values may be added; show an unknown value as is (or generically).

rolestring · can be null

The role the domain declares for the address (domain_side.role); null when not found. Known values: 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. New values may be added; show an unknown value as is (or generically).

role_mismatchobject · can be null

Set when the domain's role and the address's published owner label disagree; such a link is never counted for fee accounting. Null otherwise.

2 fields in role_mismatch
domain_rolestring

The role the domain declares. Known values: 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. New values may be added; show an unknown value as is (or generically).

claim_rolestring

The role of the address's published owner label (added by signature). Known values: 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. New values may be added; show an unknown value as is (or generically).

accounting_statusstring

Fee accounting as this check sees it now (computed, not stored): counted when the link is two_way, the domain's role is fee_wallet and any published owner label agrees; pending_review when a fee_wallet role is declared but the link is one-sided or the roles differ; not_counted when no side declares fee_wallet. New values may be added; show an unknown value as is (or generically).

accounting_reasonstring · can be null

Why a fee_wallet link is pending_review: one_sided (only one side vouches), domain_role_not_fee_wallet (only the signed label says fee_wallet), role_mismatch (the roles differ), proxied_remark (the key side is a remark a proxy submitted, not the address's own signature). Null when counted or not_counted. An open set. New values may be added; show an unknown value as is (or generically).

domain_sideobject

The domain's side, fetched live.

5 fields in domain_side
foundboolean

True when the domain's file or one of its TXT records lists the address.

viastring · can be null

Where it was found: file (https://<domain>/.well-known/bittensor-addresses.json, tried first) or dns (a TXT record at _bittensor.<domain>). Null when not found. New values may be added; show an unknown value as is (or generically).

rolestring · can be null

The role the domain declares for the address (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, team_vesting, market_maker, other); null when not found. Known values: 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. New values may be added; show an unknown value as is (or generically).

entitystring · can be null

The file's entity (the name the domain gives itself), plain text; null when not found, found through DNS, or the file names none, and also when it breaks the display-text rules (2 to 48 characters, one script, no control, bidi or invisible characters, no URL) or names a protected brand (a domain's self-description is not verified).

errorstring · can be null

Why it was not found (null when found): not_found (no file and no TXT record), address_not_listed (a file or TXT records exist but do not list this address), unresolvable, blocked_address (the name resolves to a private, loopback, link-local, shared or multicast address, which is never fetched), tls_error (the HTTPS certificate does not verify), timeout (no answer within 5 s), connection_error, redirect_off_domain (only redirects to HTTPS on the same host are followed), too_many_redirects (more than 3), http_error (a status other than 200 or 404), too_large (over 64 KB), invalid_json, schema_invalid (not version 1 with an addresses list whose every entry has a valid address and a known role), txt_invalid (TXT records not in the v=1; address=...; role=... form), dns_error, busy (too many domain checks are running at once; check again shortly). An open set. New values may be added; show an unknown value as is (or generically).

key_sideobject

The key's side, read from the chain.

5 fields in key_side
foundboolean

True when the account's current on-chain identity URL is the domain (or its www. form), or its newest domain remark for this domain links it.

viastring · can be null

The proof found: identity_url (checked first) or remark (System.remark_with_event from the address, directly or through its proxy, with the exact text bittensor domain v1 <domain>). Null when not found. New values may be added; show an unknown value as is (or generically).

at_blockinteger · unit block · can be null

The block of the proof: the identity's last change, or the remark's block. On error removed, the block of the removing remark. Null otherwise.

errorstring · can be null

Why it was not found, when there is a reason (null otherwise, also when simply absent): removed (the newest domain remark is bittensor domain v1 remove <domain>), unsupported_address (an H160 cannot sign the proof), source_unavailable (the chain could not be read just now; check again), scan_limited (the address has more recent remarks than one check reads, none of them for this domain). An open set. New values may be added; show an unknown value as is (or generically).

proxiedboolean

True when the proof is a remark submitted through a proxy of the address rather than signed by the address itself: the link holds, but fee accounting holds it for review (accounting_reason proxied_remark). False otherwise.

missingarray of string

What is still needed, as plain-text steps to show the user (empty at two_way with no role mismatch).

checked_atstring (date-time)

When this check ran (RFC 3339, UTC).

Format: date and time, ISO 8601 in UTC

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.