Get pool registrations by epoch

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

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

fetch('https://nexus.gerowallet.io/api/pools/registrations/{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/registrations/{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/registrations/{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/registrations/{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

""

[
  {
    "blockNumber": 123,
    "blockTime": 123,
    "txHash": "<string>",
    "certIndex": 123,
    "txIndex": 123,
    "poolId": "<string>",
    "vrfKeyHash": "<string>",
    "pledge": 123,
    "cost": 123,
    "margin": 123,
    "marginNumerator": 123,
    "marginDenominator": 123,
    "rewardAccount": "<string>",
    "poolOwners": [
      "<string>"
    ],
    "relays": [
      {
        "ipv4": "<string>",
        "ipv6": "<string>",
        "dns": "<string>",
        "port": 123
      }
    ],
    "metadataUrl": "<string>",
    "metadataHash": "<string>",
    "epoch": 123,
    "slot": 123,
    "blockHash": "<string>",
    "poolIdBech32": "<string>"
  }
]

[
  {
    "blockNumber": 123,
    "blockTime": 123,
    "txHash": "<string>",
    "certIndex": 123,
    "txIndex": 123,
    "poolId": "<string>",
    "vrfKeyHash": "<string>",
    "pledge": 123,
    "cost": 123,
    "margin": 123,
    "marginNumerator": 123,
    "marginDenominator": 123,
    "rewardAccount": "<string>",
    "poolOwners": [
      "<string>"
    ],
    "relays": [
      {
        "ipv4": "<string>",
        "ipv6": "<string>",
        "dns": "<string>",
        "port": 123
      }
    ],
    "metadataUrl": "<string>",
    "metadataHash": "<string>",
    "epoch": 123,
    "slot": 123,
    "blockHash": "<string>",
    "poolIdBech32": "<string>"
  }
]

[
  {
    "blockNumber": 123,
    "blockTime": 123,
    "txHash": "<string>",
    "certIndex": 123,
    "txIndex": 123,
    "poolId": "<string>",
    "vrfKeyHash": "<string>",
    "pledge": 123,
    "cost": 123,
    "margin": 123,
    "marginNumerator": 123,
    "marginDenominator": 123,
    "rewardAccount": "<string>",
    "poolOwners": [
      "<string>"
    ],
    "relays": [
      {
        "ipv4": "<string>",
        "ipv6": "<string>",
        "dns": "<string>",
        "port": 123
      }
    ],
    "metadataUrl": "<string>",
    "metadataHash": "<string>",
    "epoch": 123,
    "slot": 123,
    "blockHash": "<string>",
    "poolIdBech32": "<string>"
  }
]

[
  {
    "blockNumber": 123,
    "blockTime": 123,
    "txHash": "<string>",
    "certIndex": 123,
    "txIndex": 123,
    "poolId": "<string>",
    "vrfKeyHash": "<string>",
    "pledge": 123,
    "cost": 123,
    "margin": 123,
    "marginNumerator": 123,
    "marginDenominator": 123,
    "rewardAccount": "<string>",
    "poolOwners": [
      "<string>"
    ],
    "relays": [
      {
        "ipv4": "<string>",
        "ipv6": "<string>",
        "dns": "<string>",
        "port": 123
      }
    ],
    "metadataUrl": "<string>",
    "metadataHash": "<string>",
    "epoch": 123,
    "slot": 123,
    "blockHash": "<string>",
    "poolIdBech32": "<string>"
  }
]

GET

api

pools

registrations

{epoch}

Get pool registrations by epoch

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

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

fetch('https://nexus.gerowallet.io/api/pools/registrations/{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/registrations/{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/registrations/{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/registrations/{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

""

[
  {
    "blockNumber": 123,
    "blockTime": 123,
    "txHash": "<string>",
    "certIndex": 123,
    "txIndex": 123,
    "poolId": "<string>",
    "vrfKeyHash": "<string>",
    "pledge": 123,
    "cost": 123,
    "margin": 123,
    "marginNumerator": 123,
    "marginDenominator": 123,
    "rewardAccount": "<string>",
    "poolOwners": [
      "<string>"
    ],
    "relays": [
      {
        "ipv4": "<string>",
        "ipv6": "<string>",
        "dns": "<string>",
        "port": 123
      }
    ],
    "metadataUrl": "<string>",
    "metadataHash": "<string>",
    "epoch": 123,
    "slot": 123,
    "blockHash": "<string>",
    "poolIdBech32": "<string>"
  }
]

[
  {
    "blockNumber": 123,
    "blockTime": 123,
    "txHash": "<string>",
    "certIndex": 123,
    "txIndex": 123,
    "poolId": "<string>",
    "vrfKeyHash": "<string>",
    "pledge": 123,
    "cost": 123,
    "margin": 123,
    "marginNumerator": 123,
    "marginDenominator": 123,
    "rewardAccount": "<string>",
    "poolOwners": [
      "<string>"
    ],
    "relays": [
      {
        "ipv4": "<string>",
        "ipv6": "<string>",
        "dns": "<string>",
        "port": 123
      }
    ],
    "metadataUrl": "<string>",
    "metadataHash": "<string>",
    "epoch": 123,
    "slot": 123,
    "blockHash": "<string>",
    "poolIdBech32": "<string>"
  }
]

[
  {
    "blockNumber": 123,
    "blockTime": 123,
    "txHash": "<string>",
    "certIndex": 123,
    "txIndex": 123,
    "poolId": "<string>",
    "vrfKeyHash": "<string>",
    "pledge": 123,
    "cost": 123,
    "margin": 123,
    "marginNumerator": 123,
    "marginDenominator": 123,
    "rewardAccount": "<string>",
    "poolOwners": [
      "<string>"
    ],
    "relays": [
      {
        "ipv4": "<string>",
        "ipv6": "<string>",
        "dns": "<string>",
        "port": 123
      }
    ],
    "metadataUrl": "<string>",
    "metadataHash": "<string>",
    "epoch": 123,
    "slot": 123,
    "blockHash": "<string>",
    "poolIdBech32": "<string>"
  }
]

[
  {
    "blockNumber": 123,
    "blockTime": 123,
    "txHash": "<string>",
    "certIndex": 123,
    "txIndex": 123,
    "poolId": "<string>",
    "vrfKeyHash": "<string>",
    "pledge": 123,
    "cost": 123,
    "margin": 123,
    "marginNumerator": 123,
    "marginDenominator": 123,
    "rewardAccount": "<string>",
    "poolOwners": [
      "<string>"
    ],
    "relays": [
      {
        "ipv4": "<string>",
        "ipv6": "<string>",
        "dns": "<string>",
        "port": 123
      }
    ],
    "metadataUrl": "<string>",
    "metadataHash": "<string>",
    "epoch": 123,
    "slot": 123,
    "blockHash": "<string>",
    "poolIdBech32": "<string>"
  }
]

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

epoch

string

default:""

required

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

page

string

default:""

Page number (1-based)

pageSize

string

default:""

Number of items per page

Response

Successfully retrieved pool registrations

blockNumber

integer<int64>

blockTime

integer<int64>

txHash

string

certIndex

integer<int32>

txIndex

integer<int32>

poolId

string

vrfKeyHash

string

pledge

integer<int64>

cost

integer<int64>

margin

number

marginNumerator

integer<int64>

marginDenominator

integer<int64>

rewardAccount

string

poolOwners

string[]

relays

object[]

Show child attributes

metadataUrl

string

metadataHash

string

epoch

integer<int32>

slot

integer<int64>

blockHash

string

poolIdBech32

string

{key}

any

Getting Started

Core Concepts

Add-ons & Streaming

API Reference

Get pool registrations by epoch

Authorizations

API key (programmatic access — recommended)

Path Parameters

Query Parameters

Response