Get Delegator Gross APY

get

https://example.com/api/v1/{network}/data/delegator/apy

Get a list of delegator annual percentage yield (Gross APY).

Path Params

network

string

enum

required

Network name.

Allowed:

Query Params

startAt

date-time

Timestamp of the report data period start in the ISO 8601 format. If not specified, the default value is the one month ago.

finishAt

date-time

Timestamp of the report data period finish in the ISO 8601 format. If not specified, the default value is the current date.

startNumber

int64

Start number of the staking period.

finishNumber

int64

Finish number of the staking period.

limit

int32

1 to 1000

Number of resources that a single response page contains.

offset

int32

0 to 10000000

Number of resources to exclude from a response.

address

string

required

Delegator address in the required network.

addressType

string

enum

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

Allowed:

validatorAddress

string

Validator address in the required network for this delegator.

groupBy

string

enum

Group the report data:

`stakingPeriod` — aggregate the results by epoch
`day` — aggregate the results by days
`all` — aggregate the results over the entire period

Allowed:

skip

string

enum

Exclude breakdown by validator from the data report.

Allowed:

rewardTypes

array of strings

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).

rewardTypes

Responses

200OK

400Bad request

401Unauthorized

500Internal server error