Skip to main content

Documentation Index

Fetch the complete documentation index at: https://nexus.gerowallet.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

The Stake Pools API provides endpoints for querying stake pool information on the Cardano blockchain. You can retrieve pool metadata, performance metrics, delegator information, and registration/retirement history.

​
Available endpoints

List all pools

Get a list of all registered stake pools

Get pool info

Retrieve detailed information about a specific pool

Get pool epoch stats

Get pool statistics for a specific epoch

List registrations

Get pool registration history

List retirements

Get pool retirement announcements

​
Pool identifiers

Stake pools are identified by their pool ID, which can be in two formats:
FormatExampleDescription
Bech32pool1abc...Human-readable format
Hexabc123...56-character hex string
Both formats are accepted by all endpoints.

​
Pool information

The pool info endpoint returns:
  • pool_id - Pool identifier
  • hex - Pool ID in hex format
  • vrf_key - VRF verification key hash
  • blocks_minted - Total blocks produced
  • blocks_epoch - Blocks produced this epoch
  • live_stake - Current live stake
  • live_size - Pool size relative to total stake
  • live_saturation - Saturation percentage
  • live_delegators - Number of delegators
  • active_stake - Active stake for current epoch
  • active_size - Active pool size
  • declared_pledge - Declared pledge amount
  • live_pledge - Current pledge amount
  • margin_cost - Pool margin (0-1)
  • fixed_cost - Fixed cost per epoch
  • reward_account - Reward address
  • owners - Array of owner stake addresses
  • registration - Registration transaction details
  • retirement - Retirement announcement (if any)

​
Pool metadata

Pool operators can register metadata including:
  • name - Pool name
  • ticker - Short ticker symbol (3-5 characters)
  • description - Pool description
  • homepage - Website URL
  • extended - Extended metadata URL
{
  "pool_id": "pool1abc...",
  "metadata": {
    "name": "Example Pool",
    "ticker": "EXPL",
    "description": "A reliable stake pool",
    "homepage": "https://example-pool.io"
  },
  "live_stake": "50000000000000",
  "live_saturation": 0.75,
  "margin_cost": 0.02,
  "fixed_cost": "340000000"
}

​
Pool performance

Epoch-specific statistics include:
  • epoch - Epoch number
  • blocks - Blocks produced
  • active_stake - Stake for that epoch
  • active_size - Relative size
  • delegator_rewards - Rewards distributed

​
Pagination

List endpoints support pagination:
ParameterDefaultMaxDescription
page11000Page number (1-based)
pageSize100100Items per page

​
Example: Get pool information

curl -X GET "https://nexus-dev.gerowallet.io/api/pools/pool1abc...?network=MAINNET" \
  -H "Authorization: Bearer your-token"