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

List game party scores

GET 

/api/v2/games/party-scores

Get a list of party scores for the given filters

Request

Query Parameters

    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.

    filter.gameIds string[]

    Restrict game scores to those in the given games.

    filter.teamIds string[]

    Restrict game scores to the parties in the given teams.

    filter.partyIds string[]

    Restrict game scores to those relating to the given parties.

    filter.epochFrom uint64

    Restrict game scores to those from a given epoch.

    filter.epochTo uint64

    Restrict game scores to those up to a given epoch.

Responses

A successful response.

Schema
    partyScores object

    Page of party game scores data and corresponding page information.

    edges object[]

    Page of orders and their corresponding cursors.

  • Array [
  • cursor string

    Cursor that can be used to fetch further pages.

    node object

    Data associated with an order submitted to a Vega node.

    epoch int64

    Epoch when these scores were generated.

    gameId string

    Game ID.

    isEligible boolean

    If the party is eligible for a reward for this game based on the current information.

    openVolume string

    Party's current open volume. Only populated if the game has a requirement for it.

    party string

    The party ID.

    rank uint64

    If the party is a member of a team, this is their relative position in the sorting order of the team. Empty if not a team, or if the party is not eligible.

    score string

    Party's current score in the game.

    stakingBalance string

    Party's current staking balance. Only populated if the game has a requirement for it.

    teamId string

    Team the party belongs to. Unset if the party is not part of a team.

    time int64

    Timestamp in Unix nanoseconds when these scores were generated.

    totalFeesPaid string

    Total fees paid by the party during the relevant period.

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