Get Delegator APY
Get a list of delegator annual percentage yield (Gross APY).
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Network name.
ethereum, solana, polkadot, kusama, sui, ton, cardano, celestia Query Parameters
Timestamp of the report data period start in the ISO 8601 format. If not specified, the default value is the one month ago.
"2024-01-01T00:00:00.000Z"
Timestamp of the report data period finish in the ISO 8601 format. If not specified, the default value is the current date.
"2024-01-01T00:00:00.000Z"
Start number of the staking period.
Finish number of the staking period.
Number of resources that a single response page contains.
1 <= x <= 100050
Number of resources to exclude from a response.
0 <= x <= 100000000
Delegator address in the required network.
Delegator address type in the required network:
- `deposit` — available for the Ethereum network (used by default)
- `withdrawal` — available for the Ethereum network
- `delegator` — available for the Polygon, Solana, Cosmos, Near, and Sui networks (used by default)
- `stake_account` — available for the Solana
- `nominator` — available for the TON and Polkadot networks (used by default)
- `nominator_reward_account` — available for the Polkadot networks
deposit, withdrawal, nominator, nominator_reward_account, delegator, stake_account Validator address in the required network for this delegator.
Group the report data:
- `stakingPeriod` — aggregate the results by epoch
- `day` — aggregate the results by days
- `all` — aggregate the results over the entire period
stakingPeriod, day, all Exclude breakdown by validator from the data report.
validator Filter rewards by type. Accepts a single string or repeated keys (e.g. ?rewardTypes=delegator+staking+reward). Pass all to return all reward types regardless of defaults (e.g. ?rewardTypes=all).