Get a Stream of Yield Summaries

Returns a network-wide stream of yield summaries for the specified type and time range. Results are streamed in NDJSON format.

For more details on yield metrics and how they are calculated, see the Yield Metrics overview.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Defaults to mainnet

The blockchain network to query (e.g., mainnet).

string
enum
required

The type of yield data to retrieve:

  • validator: includes the validator’s own rewards.
  • delegator: includes rewards distributed to delegators of that validator.

Call both endpoints and aggregate the results to get a complete network-wide view.

Allowed:
Query Params
number
required

Epoch-based start time for reward queries.

number
required

Epoch-based end time for reward queries.

string
enum
Defaults to lamports

The unit to return the yield in (e.g., lamports).

Allowed:
boolean
Defaults to false

Gives the yield values raw per-epoch. Set to true to get per-epoch raw values.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/x-ndjson
application/json