Methods
Unless stated otherwise, thestartAt–finishAt range cannot exceed 31 days, and finishNumber cannot be lower than startNumber. The addressType values accepted by each network are listed in Getting Started.
Get Delegator Summary
Endpoint: GET /api/v1/{network}/data/delegator/summary Supported networks: Ethereum, Solana, Polkadot, Kusama, Sui, TON, Cardano, Celestia. Description: Utilize this endpoint to obtain the basic general information about a delegator for the period, such as a list of rewards earned by the delegator, the current stake, and the gross and net APY (grossApy, netApy) associated with the delegator.
Get Delegator Stake
Endpoint: GET /api/v1/{network}/data/delegator/stakes Supported networks: Ethereum, Solana, Polkadot, Kusama, Sui, TON, Cardano, Celestia. Description: Utilize this endpoint to monitor the current stake of a delegator. Regularly check the stake data to assess the delegator’s commitment and participation in the network.groupBy selects the aggregation: stakingPeriod aggregates by epoch, day by calendar day, all over the whole requested period. groupBy=day cannot be combined with startNumber / finishNumber; use startAt / finishAt instead, otherwise the request returns 400.
stake is the total stake balance of the delegator. On Ethereum it includes ETH that is still in the deposit or activation queue. With groupBy=day on Ethereum, the response additionally contains the optional fields activeStake (already active on the Beacon Chain) and inactiveStake (still waiting to be activated), which together make up stake. Historical Ethereum data is available from 2024-01-01.
Get Delegator Rewards
Endpoint: GET /api/v1/{network}/data/delegator/rewards Supported networks: Ethereum, Solana, Polkadot, Kusama, Sui, TON, Cardano, Celestia. Description: Utilize this endpoint to track the rewards earned by the delegator. Monitor reward data to assess the delegator’s performance and profitability. UserewardTypes to filter by reward type and skip=validator to drop the per-validator breakdown.
Get Delegator APY
Endpoint: GET /api/v1/{network}/data/delegator/apy Supported networks: Ethereum, Solana, Polkadot, Kusama, Sui, TON, Cardano, Celestia. Description: Utilize this endpoint to understand the APY associated with the delegator. The response containsgrossApy (before the validator fee) and netApy (after the fee). Regularly check APY data for insights into the delegator’s long-term performance.
Get Total Delegator Rewards
Endpoint: GET /api/v1/{network}/data/delegator/total-rewards Supported networks: Ethereum. Description: Utilize this endpoint to track the total rewards earned by the delegator over its lifetime.Get Delegator APR
Endpoint: GET /api/v1/{network}/data/delegator/apr Supported networks: Ethereum. Description: Utilize this endpoint to obtain the lifetime Annual Percentage Rate (APR) of the delegator, returned asapr. Only address is required.
Get Delegator Rewards (SSV)
Endpoint: GET /api/v1/{network}/data/delegator/ssv Supported networks: Ethereum. Description: Utilize this endpoint to obtain the monthly SSV rewards for a delegator address. Each item covers onemonth and contains distributedAmount, claimedAmount, predictedAmount, the P2P fee, and netAmount (claimed minus fee).