Sign in

v1

latestOpenAPI 3.1.02026-07-24223580832.9 KB
Cardano Staking Reporting

Get the Historical Stake and Rewards of a Pool

Returns the historical stake and rewards allocated to a given staking pool.

post/v1/cardano/mainnet/pool/history/{address}

Path parameters

addressstring required
Example:pool1af7dmzgcyp9kc5lyrtrtpsce58l6j5cjvc8wavkwmzlr53ym50v

A single public address to check

Request body

fromTimeinteger required

The Unix timestamp in seconds from which you wish to retrieve rewards.

toTimeinteger required

The Unix timestamp in seconds until which rewards are retrieved.

timeUnit'epoch' | 'daily' | 'weekly' | 'monthly' required

Represents how the rewards are aggregated. Must be one of epoch, daily, weekly, or monthly.

Example request

{
  "fromTime": 1577836800,
  "toTime": 1685491200
}

Response

Example response

{
  "rewards": [
    {
      "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"
    }
  ]
}