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 Accounts API provides endpoints for querying stake account information on the Cardano blockchain. Stake accounts manage staking delegation and receive staking rewards.

​
Available endpoints

Get account info

Retrieve stake account information and delegation status

Get account rewards

Get reward history by epoch

Get account addresses

List all addresses associated with the stake account

Get account UTXOs

Get all UTXOs controlled by the stake account

Get account transactions

Get transaction history for the stake account

​
Stake address format

Stake addresses follow the bech32 format:
NetworkPrefixExample
Mainnetstake1...stake1uxxx... (59+ characters)
Testnetstake_test1...stake_test1uxxxx... (53-59 characters)

​
Account information

The account info endpoint returns:
  • stake_address - The stake address
  • active - Whether the account is registered and active
  • active_epoch - Epoch when the account became active
  • controlled_amount - Total ADA controlled by this stake account
  • rewards_sum - Total rewards earned
  • withdrawals_sum - Total rewards withdrawn
  • reserves_sum - Rewards from reserves (MIR certificates)
  • treasury_sum - Rewards from treasury
  • withdrawable_amount - Current withdrawable rewards
  • pool_id - Delegated stake pool ID
{
  "stake_address": "stake1uxxx...",
  "active": true,
  "active_epoch": 210,
  "controlled_amount": "1234567890000",
  "rewards_sum": "12345678",
  "withdrawals_sum": "10000000",
  "reserves_sum": "0",
  "treasury_sum": "0",
  "withdrawable_amount": "2345678",
  "pool_id": "pool1abc..."
}

​
Rewards history

The rewards endpoint returns epoch-by-epoch reward information:
  • epoch - Epoch number
  • amount - Reward amount in lovelace
  • pool_id - Pool that generated the reward
  • type - Reward type (member, leader, reserves, treasury)
[
  {
    "epoch": 450,
    "amount": "123456",
    "pool_id": "pool1abc...",
    "type": "member"
  }
]

​
Example: Get staking rewards

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

​
Account addresses

A stake account can have multiple payment addresses associated with it. The addresses endpoint returns all addresses that share the same stake credential.

​
Account transactions

The transactions endpoint returns all transactions involving any address associated with the stake account, providing a complete transaction history for the account.