Skip to main content
GET
Stake account information

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

stakeAddress
string
required
Required string length: 59 - 200
Pattern: ^(stake1[a-z0-9]{53}|stake_test1[a-z0-9]{48,53})$

Query Parameters

network
enum<string>
Available options:
CARDANO_MAINNET,
CARDANO_PREPROD,
CARDANO_PREVIEW,
APEX_PRIME_MAINNET,
APEX_VECTOR_MAINNET,
APEX_VECTOR_TESTNET,
MIDNIGHT_MAINNET,
MIDNIGHT_PREPROD,
MIDNIGHT_PREVIEW,
BITCOIN_MAINNET,
BITCOIN_TESTNET4

Response

Stake account information retrieved

active
boolean
activeEpoch
integer<int32>
controlledAmount
string
rewardsSum
string
reservesSum
string
withdrawalsSum
string
treasurySum
string
withdrawableAmount
string
poolId
string
drepId
string
stakeAddress
string
utxoBalance
string
deposit
string
proposalRefund
string
{key}
any