Overview
The Blockdaemon Cardano Staking Reporting API helps with financial analysis and performance tracking by allowing you to retrieve both current and historical stake and reward data for pools and delegators.
Supported network: Mainnet
Cardano Epochs
What are Epochs?
In Cardano, an epoch is a 5-day cycle in which rewards for staking are calculated and paid out. Cardano is a proof-of-stake (PoS) blockchain, meaning that you can stake your ADA to help secure the network and support its operations. In return, you earn rewards, which are added to your stake.
How does it work?
The process of earning rewards through staking on Cardano happens in a 5-step cycle over each epoch.
| Epoch(s) | Days | Action |
|---|---|---|
| Epoch 1 (E1) | Days 0-5 | You begin staking your ADA by sending it to a stake pool. |
| Epoch 2 (E2) | Days 5-10 | Your stake is registered to the chosen pool. |
| Epoch 3 (E3) | Days 10-15 | Your stake is active and rewards begin to accumulate. |
| Epoch 4 (E4) | Days 15-20 | The system calculates your rewards based on the activity in the previous epoch (E3). |
| Epoch 5 (E5) | Days 20-25 | Your rewards are paid out to your wallet for the stake you made in E3. |
Rewards may take 15-20 days to arrive due to Cardano's 5-epoch process, but after the first payout, you'll receive rewards every 5 days. They are automatically compounded and sent directly to your wallet.
➡️ Stake & Rewards of a Pool
This endpoint retrieves the current or historical staking rewards and balances for a given pool. It includes information such as the total rewards, commission rates, and the time period for which the data is aggregated.
Endpoints
| Endpoint |
|---|
Get the Stake and Rewards of a Pool - GET /pool/rewards/{address} |
Get the Stake and Rewards for Multiple Pools - POST /pool/rewards |
Get the Historical Stake and Rewards of a Pool - POST /pool/history/{address} |
Get the Historical Stake and Rewards for Multiple Pools - POST /pool/history |
Sample Object
The example object returned by the Stake and Rewards of a Pool endpoint is shown below.
{
"rewards": [
{
"address": "pool1af7dmzgcyp9kc5lyrtrtpsce58l6j5cjvc8wavkwmzlr53ym50v",
"currency": "ADA",
"metadata": {
"commission": 0.02,
"epoch": 520
},
"return": "298.529184",
"startingBalance": "59601.936023",
"timeAggregation": "epoch",
"timeEnd": "2024-11-10T21:44:16Z",
"timeStart": "2024-11-05T21:44:57Z"
}
]
}
The example above shows that the latest payout you should expect via our reporting API is for rewards from epoch 520, which ended on November 10th.
➡️ Stake & Rewards of Delegator
This endpoint retrieves the current or historical staking rewards and balances for a given delegator address.
Endpoints
| Endpoint |
|---|
Get the Stake and Rewards of a Delegator - GET delegator/rewards/{address} |
Get the Stake and Rewards for Multiple Delegators - POST delegator/rewards |
Get the Historical Stake and Rewards of a Delegator - POST delegator/history/{address} |
Get the Historical Stake and Rewards for Multiple Delegators - POST delegator/history |
Sample Object
The example object returned by the Stake and Rewards of a Delegator endpoint is shown below.
{
"rewards": [
{
"address": "stake1ux9sn560pz6skkjuhfz8s3j0a4wf9flxt00kfgfg3ngnnxsvzfw5q",
"currency": "ADA",
"metadata": {
"commission": 0,
"epoch": 520
},
"return": "2.887300",
"startingBalance": "7269.984627",
"timeAggregation": "epoch",
"timeEnd": "2024-11-10T21:44:16Z",
"timeStart": "2024-11-05T21:44:57Z"
}
]
}
The example above shows that the latest payout you should expect via our reporting API is for rewards from epoch 520, which ended on November 10th.
👋 Need Help?
Contact us through email or our support page for any issues, bugs, or assistance you may need.