Skip to main content
GET
Stake pool 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

id
string
required
Minimum string length: 1

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

Successfully retrieved pool information

poolIdBech32
string
poolIdHex
string
poolStatus
string
activeEpochNo
integer<int64>
retiringEpoch
integer<int64>
marginPct
number
fixedCost
integer
pledgeDeclared
integer
deposit
integer
rewardAddr
string
owners
string[]
relays
object[]
metaUrl
string
metaHash
string
metaJson
any
vrfKeyHash
string
opCertCounter
integer<int64>
blockCount
integer<int64>
blocksMinted
integer<int64>
activeStake
integer
liveStake
integer
livePledge
integer
sigma
number
liveSaturationPct
number
liveStakePct
number
liveDelegators
integer<int64>
ticker
string
poolGroup
string
name
string
homepage
string
description
string
ros
number<double>
extendedMetadata
any
{key}
any