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

List reward summaries

GET 

/api/v2/rewards/summaries

Get a list of reward summaries where the reward amount is the total rewards received over all epochs per party ID and asset ID. Request parameters are optional party ID and asset ID. If no data is provided, all reward summaries will be returned grouped by party and asset ID.

Request

Query Parameters

    partyId string

    Restrict the reward summary to rewards paid to the given parties.

    assetId string

    Restrict the reward summary to rewards paid in the given assets.

    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.

    includeDerivedParties boolean

    Whether to return rewards for all derived parties from AMMs for the given party. If used, party ID is required.

Responses

A successful response.

Schema
    summaries object[]

    Page of rewards details data and corresponding page information.

  • Array [
  • amount string

    Total amount of rewards paid in the asset. This field is an unsigned integer scaled to the asset's decimal places.

    assetId string

    Asset ID in which the reward is being paid.

    partyId string

    Party ID to whom the reward is being paid.

  • ]
Loading...