Skip to content
—
QuantascanAlpha
Browse API groups

Address Names API

The display name for an address: a curated Quantascan label when one exists, otherwise a unique auto-generated nickname. Nicknames are a pure function of the address — the algorithm, word lists and golden vectors are published at /nicknames/v1/ so you can compute virtually every name offline and use these endpoints only for curated labels and the small collision-arbitration list.
GET/api/v1/{chain}/names/{address}QRL 2.0QRL (PoW)

Name For Address

The display name for one address.

Always returns a name, also for an address we have never indexed: the nickname depends on the address alone.

Path parameters

  • addressrequired
    string

Response 200 · AddressName

addressstringrequired
chainstringrequired
namestringrequired
sourcestringrequired'official_label' or 'nickname'
categorystring | nullLabel category when source='official_label'
nicknamestringrequiredThe auto-generated name, regardless of source
assignedbooleanrequiredDeprecated, always true. Under spec v3 the nickname is a pure function of the address and final the moment it is computed.
attemptintegerDeprecated, always 0. Spec v3 has no collision attempts.
ruleset_versionstringrequired

Request examples

curl -s "https://quantascan.io/api/v1/qrl2/names/<address>" \
  -H "Authorization: Bearer qs_YOUR_API_KEY"
GET/api/v1/{chain}/names/directoryQRL 2.0QRL (PoW)

Label Directory

All curated Quantascan labels for the chain — fetch once, join locally.

Query parameters

  • limitoptional
    integermin 1 · max 10000default 2000
  • offsetoptional
    integermin 0default 0

Response 200 · LabelDirectory

▸
itemsLabelDirectoryItem[]
addressstringrequired
labelstringrequired
categorystringrequired
totalinteger
chainstringrequired

Request examples

curl -s "https://quantascan.io/api/v1/qrl2/names/directory" \
  -H "Authorization: Bearer qs_YOUR_API_KEY"
GET/api/v1/{chain}/names/exceptionsQRL 2.0QRL (PoW)

Nickname Exceptions

Deprecated: always an empty list.

Under spec v2 a few addresses had a registry name that differed from the published algorithm, and this list carried them. Spec v3 has no registry: the published algorithm IS the name, for every address. Stop polling.

Query parameters

  • sinceoptional
    string | null

    Ignored. Kept for spec-v2 clients.

  • limitoptional
    integermin 1 · max 20000default 5000

    Ignored.

  • offsetoptional
    integermin 0default 0

    Ignored.

Response 200 · NicknameExceptionsList

▸
itemsNicknameException[]
chainstringrequired
networkstringrequired
addressstringrequired
nicknamestringrequired
attemptintegerrequired
assigned_atstring | null
totalinteger
ruleset_versionstringrequired
as_ofstring | nullHigh-water mark. Pass it back as `since` on the next poll to fetch only what was added in between.

Request examples

curl -s "https://quantascan.io/api/v1/qrl2/names/exceptions" \
  -H "Authorization: Bearer qs_YOUR_API_KEY"
POST/api/v1/{chain}/names/resolveQRL 2.0QRL (PoW)

Resolve Names

Resolve display names for many addresses in one call.

One request = one metered API call, so a view with thousands of wallets costs a handful of calls rather than thousands.

Response 200 · AddressNamesList

▸
itemsAddressName[]
addressstringrequired
chainstringrequired
namestringrequired
sourcestringrequired'official_label' or 'nickname'
categorystring | nullLabel category when source='official_label'
nicknamestringrequiredThe auto-generated name, regardless of source
assignedbooleanrequiredDeprecated, always true. Under spec v3 the nickname is a pure function of the address and final the moment it is computed.
attemptintegerDeprecated, always 0. Spec v3 has no collision attempts.
ruleset_versionstringrequired
countinteger

Request examples

curl -s -X POST "https://quantascan.io/api/v1/qrl2/names/resolve" \
  -H "Authorization: Bearer qs_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"addresses":["Qc0e6dd0e844e0048dcb0bd3fdcc44a970beca38d"]}'

All endpoints verified against a live indexer. Need the raw spec? See openapi.json or the API overview.