Rewards

post

https://api.figment.io/ethereum/rewards

Body Params

time_rollup

string

enum

required

The granularity of the rewards data. Use epoch for one record per validator per epoch, daily for rewards aggregated by UTC calendar day, or all_time for cumulative rewards since validator activation.

Allowed:

start

string

required

Lower bound of rewards data. For epoch time_rollup: accepts an epoch number as an integer (e.g. 261702) or a date string ("YYYY-MM-DD"). For daily time_rollup: accepts a date string ("YYYY-MM-DD"). Ignored for all_time time_rollup.

end

string

required

Upper bound of rewards data. For epoch time_rollup: accepts an epoch number as an integer (e.g. 261703) or a date string ("YYYY-MM-DD"). For daily time_rollup: accepts a date string ("YYYY-MM-DD"). Ignored for all_time time_rollup.

groups

string

Filter using comma-separated group uuids.

network

string

enum

Defaults to mainnet

Allowed:

pubkeys

array of strings

A list of validator pubkeys for filtering.

pubkeys

withdrawal_addresses

array of strings

A list of withdrawal addresses or credentials for filtering.

withdrawal_addresses

page

object

Responses

Language

Response

Choose an example:

application/json

200List of rewards and balances aggregated for all addresses registered to the organization and rolled up to the requested time_rollup.

400Parameter error

401Unauthorized

500System error