Get stake pool statistics for a specific epoch

curl --request GET \
  --url https://nexus.gerowallet.io/api/pools/{poolId}/epochs/{epoch} \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://nexus.gerowallet.io/api/pools/{poolId}/epochs/{epoch}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://nexus.gerowallet.io/api/pools/{poolId}/epochs/{epoch}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://nexus.gerowallet.io/api/pools/{poolId}/epochs/{epoch}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://nexus.gerowallet.io/api/pools/{poolId}/epochs/{epoch}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

""

{
  "epoch": 123,
  "pledge": "<string>",
  "cost": "<string>",
  "margin": 123,
  "relays": [
    {
      "ipv4": "<string>",
      "ipv6": "<string>",
      "dns": "<string>",
      "port": 123
    }
  ],
  "status": "<string>",
  "ros": 123,
  "extendedMetadata": "<unknown>",
  "pool_id": "<string>",
  "pool_hash": "<string>",
  "vrf_key_hash": "<string>",
  "reward_account": "<string>",
  "pool_owners": [
    "<string>"
  ],
  "metadata_url": "<string>",
  "metadata_hash": "<string>",
  "tx_hash": "<string>",
  "cert_index": 123,
  "retire_epoch": 123
}

{
  "epoch": 123,
  "pledge": "<string>",
  "cost": "<string>",
  "margin": 123,
  "relays": [
    {
      "ipv4": "<string>",
      "ipv6": "<string>",
      "dns": "<string>",
      "port": 123
    }
  ],
  "status": "<string>",
  "ros": 123,
  "extendedMetadata": "<unknown>",
  "pool_id": "<string>",
  "pool_hash": "<string>",
  "vrf_key_hash": "<string>",
  "reward_account": "<string>",
  "pool_owners": [
    "<string>"
  ],
  "metadata_url": "<string>",
  "metadata_hash": "<string>",
  "tx_hash": "<string>",
  "cert_index": 123,
  "retire_epoch": 123
}

{
  "epoch": 123,
  "pledge": "<string>",
  "cost": "<string>",
  "margin": 123,
  "relays": [
    {
      "ipv4": "<string>",
      "ipv6": "<string>",
      "dns": "<string>",
      "port": 123
    }
  ],
  "status": "<string>",
  "ros": 123,
  "extendedMetadata": "<unknown>",
  "pool_id": "<string>",
  "pool_hash": "<string>",
  "vrf_key_hash": "<string>",
  "reward_account": "<string>",
  "pool_owners": [
    "<string>"
  ],
  "metadata_url": "<string>",
  "metadata_hash": "<string>",
  "tx_hash": "<string>",
  "cert_index": 123,
  "retire_epoch": 123
}

{
  "epoch": 123,
  "pledge": "<string>",
  "cost": "<string>",
  "margin": 123,
  "relays": [
    {
      "ipv4": "<string>",
      "ipv6": "<string>",
      "dns": "<string>",
      "port": 123
    }
  ],
  "status": "<string>",
  "ros": 123,
  "extendedMetadata": "<unknown>",
  "pool_id": "<string>",
  "pool_hash": "<string>",
  "vrf_key_hash": "<string>",
  "reward_account": "<string>",
  "pool_owners": [
    "<string>"
  ],
  "metadata_url": "<string>",
  "metadata_hash": "<string>",
  "tx_hash": "<string>",
  "cert_index": 123,
  "retire_epoch": 123
}

GET

api

pools

{poolId}

epochs

{epoch}

Get stake pool statistics for a specific epoch

curl --request GET \
  --url https://nexus.gerowallet.io/api/pools/{poolId}/epochs/{epoch} \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://nexus.gerowallet.io/api/pools/{poolId}/epochs/{epoch}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://nexus.gerowallet.io/api/pools/{poolId}/epochs/{epoch}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://nexus.gerowallet.io/api/pools/{poolId}/epochs/{epoch}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://nexus.gerowallet.io/api/pools/{poolId}/epochs/{epoch}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

""

{
  "epoch": 123,
  "pledge": "<string>",
  "cost": "<string>",
  "margin": 123,
  "relays": [
    {
      "ipv4": "<string>",
      "ipv6": "<string>",
      "dns": "<string>",
      "port": 123
    }
  ],
  "status": "<string>",
  "ros": 123,
  "extendedMetadata": "<unknown>",
  "pool_id": "<string>",
  "pool_hash": "<string>",
  "vrf_key_hash": "<string>",
  "reward_account": "<string>",
  "pool_owners": [
    "<string>"
  ],
  "metadata_url": "<string>",
  "metadata_hash": "<string>",
  "tx_hash": "<string>",
  "cert_index": 123,
  "retire_epoch": 123
}

{
  "epoch": 123,
  "pledge": "<string>",
  "cost": "<string>",
  "margin": 123,
  "relays": [
    {
      "ipv4": "<string>",
      "ipv6": "<string>",
      "dns": "<string>",
      "port": 123
    }
  ],
  "status": "<string>",
  "ros": 123,
  "extendedMetadata": "<unknown>",
  "pool_id": "<string>",
  "pool_hash": "<string>",
  "vrf_key_hash": "<string>",
  "reward_account": "<string>",
  "pool_owners": [
    "<string>"
  ],
  "metadata_url": "<string>",
  "metadata_hash": "<string>",
  "tx_hash": "<string>",
  "cert_index": 123,
  "retire_epoch": 123
}

{
  "epoch": 123,
  "pledge": "<string>",
  "cost": "<string>",
  "margin": 123,
  "relays": [
    {
      "ipv4": "<string>",
      "ipv6": "<string>",
      "dns": "<string>",
      "port": 123
    }
  ],
  "status": "<string>",
  "ros": 123,
  "extendedMetadata": "<unknown>",
  "pool_id": "<string>",
  "pool_hash": "<string>",
  "vrf_key_hash": "<string>",
  "reward_account": "<string>",
  "pool_owners": [
    "<string>"
  ],
  "metadata_url": "<string>",
  "metadata_hash": "<string>",
  "tx_hash": "<string>",
  "cert_index": 123,
  "retire_epoch": 123
}

{
  "epoch": 123,
  "pledge": "<string>",
  "cost": "<string>",
  "margin": 123,
  "relays": [
    {
      "ipv4": "<string>",
      "ipv6": "<string>",
      "dns": "<string>",
      "port": 123
    }
  ],
  "status": "<string>",
  "ros": 123,
  "extendedMetadata": "<unknown>",
  "pool_id": "<string>",
  "pool_hash": "<string>",
  "vrf_key_hash": "<string>",
  "reward_account": "<string>",
  "pool_owners": [
    "<string>"
  ],
  "metadata_url": "<string>",
  "metadata_hash": "<string>",
  "tx_hash": "<string>",
  "cert_index": 123,
  "retire_epoch": 123
}

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)

epoch

string

default:""

required

Cardano epoch number

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 stake pool epoch data

epoch

integer<int32>

pledge

string

cost

string

margin

number

relays

object[]

Show child attributes

status

string

ros

number<double>

extendedMetadata

any

pool_id

string

pool_hash

string

vrf_key_hash

string

reward_account

string

pool_owners

string[]

metadata_url

string

metadata_hash

string

tx_hash

string

cert_index

integer<int32>

retire_epoch

integer<int32>

{key}

any

Getting Started

Core Concepts

Add-ons & Streaming

API Reference

Get stake pool statistics for a specific epoch

Authorizations

API key (programmatic access — recommended)

Path Parameters

Query Parameters

Response