Skip to main content
GET
Resolve an ADA Handle to an address

Authorizations

X-Api-Key
string
header
required

API key (programmatic access — recommended)

Send your API key in the X-Api-Key header. Keys start with nxs_ and are created in the dashboard (or via POST /api/keys with a session JWT).

Each key is scoped to one chain and one network (for example CARDANO_MAINNET), fixed at creation time. It cannot query a different network on the same chain, and it cannot query a different chain at all. A mismatched network parameter returns 400 Network Mismatch. Create one key per chain and network under the same account.

This is the credential most integrations should use.

Path Parameters

handle
string
default:""
required

The handle, with or without the leading $

Required string length: 1 - 16

Query Parameters

network
enum<string>

Accepts either the value listed here (CARDANO_MAINNET) or its kebab-case alias (cardano-mainnet); matching is case-insensitive. Omit it and the network is taken from the API key. A value that disagrees with the key's own network returns 400 Network Mismatch.

Available options:
CARDANO_MAINNET,
CARDANO_PREPROD,
CARDANO_PREVIEW,
APEX_PRIME_MAINNET,
APEX_VECTOR_MAINNET,
APEX_VECTOR_TESTNET,
MIDNIGHT_MAINNET,
MIDNIGHT_PREPROD,
MIDNIGHT_STAGENET,
BITCOIN_MAINNET,
BITCOIN_TESTNET4

Response

Handle resolved

Resolution of an ADA Handle to its current holder

handle
string
default:""

The handle, normalized: lowercase and without the leading dollar sign

Example:

"charles"

address
string
default:""

Address of the unspent output currently holding the handle token

Example:

"addr1qxn76cvp3s8pnq0jzcrduh8jtnatm9hjk3g7gze8kfw8gzlshsg38lrquhlmrd44nxnyh4dwfypzl93s0c737skpcygq8psfu5"

stakeAddress
string | null
default:""

Stake address of the holder. Null when the handle sits at an enterprise address, which has no stake credential.

Example:

"stake1u8ctcygnl3swtla3k66enfjt6khyjq30jcc8u0glgtquzyqaths5q"

policyId
string
default:""

The ADA Handle minting policy

Example:

"f0ff48bbb7bbe9d59a40f1ce90e9e9d0ff5002ec48f232b49ca0fb9a"

assetNameHex
string
default:""

On-chain asset name of the token that resolved, hex-encoded, including the CIP-68 user-token prefix when there is one

Example:

"636861726c6573"

cip68
boolean
default:false

True when the resolved token is a CIP-68 user token (asset name prefixed 000de140), false for a legacy handle whose asset name is the bare UTF-8 bytes

Example:

false

{key}
any