Rewards

Timestamp convention disclaimer: Each reward distribution event is timestamped at the end of the epoch in which it was credited. Since rewards become available at the start of an epoch and each epoch lasts 5 days, the timestamp will not reflect the moment they landed, rather it’ll reflect when that same epoch closed. When filtering rewards by date range, account for this 5 day offset.

E.g.: A reward that became available at the start of epoch 600 (Apr 1) will be timestamped Apr 6, when epoch 600 closed.

API Request Structure

• start
  string | integer
  required
  Rewards received on or after this date (YYYY-MM-DD) or epoch (integer)

• end
  string | integer
  required
  Rewards received on or before this date (YYYY-MM-DD) or epoch (integer)

• delegator_addresses
  array of strings
  Optional list of delegator addresses to filter by

• network
  string
  enum
  Defaults to mainnet
  Select preprod Network if you want to test with mock data
  Allowed: mainnet, preprod

Responses

200 Got rewards

{
  "data": [
    {
      "delegator_address": "string",
      "pool_id": "string",
      "stake_key_hash": "string",
      "epoch": 450,
      "timestamp": "2024-10-11",
      "rewards": [
        {
          "text": "1.0",
          "currency": "ADA",
          "numeric": 1000000,
          "type": "member",
          "exp": 6
        }
      ],
      "balances": [
        {
          "text": "1000.0",
          "currency": "ADA",
          "numeric": 1000000,
          "exp": 6
        }
      ]
    }
  ],
  "meta": {
    "network": "mainnet",
    "time_rollup": "epoch"
  }
}

Example Curl Request

curl --request POST \
     --url https://api.figment.io/cardano/rewards_all \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: your-api-key-here' \
     --data '{
  "network": "mainnet"
}'

Error Responses

400 Bad Request

Updated 3 months ago