Skip to main content
GET
Decode a Cardano address into its credentials

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

address
string
required
Required string length: 1 - 200
Pattern: ^[a-zA-Z0-9_]+$

Query Parameters

network
string
default:""

Accepted and ignored. Decoding never consults a network.

Response

Address decoded

Decoded components of a Cardano address

address
string
default:""

The address exactly as decoded (whitespace-trimmed)

Example:

"addr1qx2fxv2umyhttkxyxp8x0dlpdt3k6cwng5pxj3jhsydzer3n0d3vllmyqwsx5wktcd8cc3sq835lu7drv2xwl2wywfgse35a3x"

era
enum<string>
default:""

Address-format era. Every post-Byron format is 'shelley'.

Available options:
shelley,
byron
Example:

"shelley"

network
enum<string>
default:""

Network the address encodes. Absent for Byron addresses: Byron carries its network as an optional protocol-magic attribute inside the address's CBOR envelope, and that parsing is not performed here, so the network is reported as undetermined rather than guessed.

Available options:
mainnet,
testnet
Example:

"mainnet"

type
enum<string>
default:""

Address type

Available options:
base,
enterprise,
pointer,
reward,
byron
Example:

"base"

paymentCredential
object

Payment (spending) credential. Null for reward and Byron addresses.

stakeCredential
object

Stake (delegation) credential. Null for enterprise, pointer and Byron addresses. For a reward address this holds the address's single credential and paymentCredential is null.

{key}
any