Sign in

v1

latestOpenAPI 3.1.02026-07-24223580832.9 KB
Cardano Staking Reporting

Get the Stake and Rewards of a Pool

Returns the staking balance and rewards earned during the most recent epoch for a pool.

get/v1/cardano/mainnet/pool/rewards/{address}

Path parameters

addressstring required
Example:pool1af7dmzgcyp9kc5lyrtrtpsce58l6j5cjvc8wavkwmzlr53ym50v

A single public address to check

Response

addressstring required

The user-defined address.

currencystring required

The cryptocurrency protocol the request relates to.

returnstring required

The sum of the rewards for the previous UTC day.

startingBalancestring required

The staked amount at the beginning of the previous UTC day (at the timeStart).

timeAggregationstring required

The agregation period. Either one of epoch, daily, weekly, or monthly.

timeEndstring required

The timestamp, in UTC, that marks the end of the period covered.

timeStartstring required

The timestamp, in UTC, that marks the start of the period covered.

Example response

{
  "currency": "ADA",
  "metadata": {
    "commission": 0.01,
    "epoch": 348
  },
  "return": "500.000000",
  "startingBalance": "5004.058667",
  "timeAggregation": "weekly",
  "timeEnd": "2022-07-31T23:59:59.000Z",
  "timeStart": "2022-07-01T00:00:00.000Z"
}