Skip to main content
GET
Get the epoch-by-epoch history of a stake pool

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

poolId
string
default:""
required

Cardano stake pool identifier (accepts both bech32 and hex formats)

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
count
string
default:""

Number of epochs per page. Omit together with page for the full history.

page
string
default:""

Page number (1-based). Defaults to 1 when count is supplied.

Response

Successfully retrieved stake pool history

margin
number
epoch_no
integer<int32>
active_stake
integer
active_stake_pct
number
saturation_pct
number
block_cnt
integer<int32>
delegator_cnt
integer<int32>
fixed_cost
integer
pool_fees
integer
deleg_rewards
integer
epoch_ros
number
{key}
any