Skip to main content
Version: pre-release (v0.78)

List epoch reward summaries

GET 

/api/v2/rewards/epoch/summaries

Get a list of reward summaries by epoch for a given range of epochs. The result is filtered by a list of asset IDs, market IDs and starting and ending epochs, for which to return rewards. If no data is provided, all reward summaries will be returned, grouped by epochs, market IDs, asset IDs and reward type.

Request

Query Parameters

    filter.assetIds string[]

    Restrict reward summaries to those connected to the assets in the given list.

    filter.marketIds string[]

    Restrict reward summaries to those connected to the markets in the given list.

    filter.fromEpoch uint64

    Restrict rewards summaries to those that were paid after and including the given epoch ID.

    filter.toEpoch uint64

    Restrict rewards summaries to those that were paid up to and including the given epoch ID.

    pagination.first int32

    Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

    pagination.after string

    If paging forwards, the cursor string for the last row of the previous page.

    pagination.last int32

    Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

    pagination.before string

    If paging forwards, the cursor string for the first row of the previous page.

    pagination.newestFirst boolean

    Whether to order the results with the newest records first. If not set, the default value is true.

Responses

A successful response.

Schema
    summaries object

    Page of rewards details for a single party and corresponding page information.

    edges object[]

    Page of rewards summary data for epochs and their corresponding cursors.

  • Array [
  • cursor string

    Cursor that can be used to fetch further pages.

    node object

    Rewards summary data for epoch.

    amount string

    Amount distributed. This field is an unsigned integer scaled to the asset's decimal places.

    assetId string

    Asset ID in which the reward is being paid.

    epoch uint64

    Epoch in which the reward is being paid.

    marketId string

    Market ID in which the reward is being paid.

    rewardType string

    Type of reward being paid.

  • ]
  • pageInfo object

    Page information that is used for fetching further pages.

    endCursor string

    End cursor.

    hasNextPage boolean

    Indicator if there is a next page.

    hasPreviousPage boolean

    Indicator if there is a previous page.

    startCursor string

    Start cursor.

Loading...