Skip to main content
Version: release (v0.77)

List rewards

GET 
/api/v2/rewards

Get a list of rewards that match the provided criteria. If no filter is provided, all rewards will be returned.

Request​

Query Parameters

    partyId string

    Restrict rewards data to those that were received by the given party.

    assetId string

    Restrict rewards data to those that were paid with the given asset 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.

    fromEpoch uint64

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

    toEpoch uint64

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

    teamId string

    Filter for rewards paid if the party is a member of the given team.

    gameId string

    Filter for rewards paid if the party participated in the given game.

    includeDerivedParties boolean

    Whether to return all derived parties from AMMs for the given party.

    marketId string

    Filter the rewards by market ID.

Responses​

A successful response.

Schema
    rewards object

    Page of rewards data and corresponding page information.

    edges object[]

    Page of rewards data items and their corresponding cursors.

  • Array [
    • cursor string

    Cursor that can be used to fetch further pages.

    node object

    Details for a single reward payment.

    amount string

    Amount paid as a reward. 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.

    gameId string

    ID of the game the reward payment was made for if the payment was made for participation in a game.

    lockedUntilEpoch uint64

    The epoch when the reward is being released.

    marketId string

    Market ID in which the reward is being paid.

    partyId string

    Party ID to whom the reward is being paid.

    percentageOfTotal string

    Percentage of total rewards paid in the epoch.

    quantumAmount string

    Amount paid as a reward, expressed in asset's quantum unit.

    receivedAt int64

    Timestamp at which the reward was paid as Unix nano time.

    rewardType string

    Type of reward being paid.

    teamId string

    ID of the team the party is a member of, if the party is a member of a participating team, and the reward payment was made for participation in a game. This field is currently only populated by the rewards API.

  • ]
    • 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...