List games

GET 
https://api.n00.testnet.vega.rocks/api/v2/games

Get a list of games and corresponding game data, given the provided filters

Request

Query Parameters

gameId string

Game ID to filter for.

epochFrom uint64

First epoch to retrieve game data from. If not provided, defaults to the last epoch minus 30, or the first epoch available if not enough epochs have passed.

epochTo uint64

Last epoch to retrieve game data to (inclusive). If not provided, defaults to the last epoch.

entityScope string
Possible values: [ENTITY_SCOPE_UNSPECIFIED, ENTITY_SCOPE_INDIVIDUALS, ENTITY_SCOPE_TEAMS]
Default value: ENTITY_SCOPE_UNSPECIFIED
Entity scope to filter games for, i.e. team games or individual games only.
• ENTITY_SCOPE_INDIVIDUALS: Rewards must be distributed directly to eligible parties.
• ENTITY_SCOPE_TEAMS: Rewards must be distributed to directly eligible teams, and then amongst team members
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

200

A successful response.

application/json

Schema

Schema

games object

Page of games data and corresponding page information.

edges object[]

Page of games data and their corresponding cursors.

Array [

cursor string

Cursor that can be used to fetch further pages.

node object

Game data.

epoch uint64

Epoch at which the last game metrics were captured.

id Unique ID of the game

individual object

individual object[]

List of individual party IDs, and the metrics associated with each participant.

Array [

individual Party ID of the individual participating

rank uint64

Rank of the individual either in the game or within their team.

rewardEarned Reward earned by the individual during the epoch

rewardEarnedQuantum Rewards earned by the individual in quantum value

rewardMetric Reward metric applied to the individual

Possible values: [DISPATCH_METRIC_UNSPECIFIED, DISPATCH_METRIC_MAKER_FEES_PAID, DISPATCH_METRIC_MAKER_FEES_RECEIVED, DISPATCH_METRIC_LP_FEES_RECEIVED, DISPATCH_METRIC_MARKET_VALUE, DISPATCH_METRIC_AVERAGE_POSITION, DISPATCH_METRIC_RELATIVE_RETURN, DISPATCH_METRIC_RETURN_VOLATILITY, DISPATCH_METRIC_VALIDATOR_RANKING]

Default value: DISPATCH_METRIC_UNSPECIFIED

totalRewardsEarned Total rewards earned by the individual for the game

totalRewardsEarnedQuantum Total rewards earned by the individual in quantum value

volume Volume traded by the individual

]

participants uint64

The number of participants in the game.

rewardAssetId string

ID of the asset rewarded for involvement in the game.

team object

team object[]

List of teams, the participant members of a team, and the metrics associated with each participant.

Array [

rank uint64

rewardEarned Reward earned by the team

rewardEarnedQuantum Rewards earned by the team in quantum value

rewardMetric Reward metric applied to the team

Possible values: [DISPATCH_METRIC_UNSPECIFIED, DISPATCH_METRIC_MAKER_FEES_PAID, DISPATCH_METRIC_MAKER_FEES_RECEIVED, DISPATCH_METRIC_LP_FEES_RECEIVED, DISPATCH_METRIC_MARKET_VALUE, DISPATCH_METRIC_AVERAGE_POSITION, DISPATCH_METRIC_RELATIVE_RETURN, DISPATCH_METRIC_RETURN_VOLATILITY, DISPATCH_METRIC_VALIDATOR_RANKING]

Default value: DISPATCH_METRIC_UNSPECIFIED

team object

Breakdown of a team's participation in a game.

membersParticipating object[]

Array [

individual Party ID of the individual participating

rank uint64

Rank of the individual either in the game or within their team.

rewardEarned Reward earned by the individual during the epoch

rewardEarnedQuantum Rewards earned by the individual in quantum value

rewardMetric Reward metric applied to the individual

Possible values: [DISPATCH_METRIC_UNSPECIFIED, DISPATCH_METRIC_MAKER_FEES_PAID, DISPATCH_METRIC_MAKER_FEES_RECEIVED, DISPATCH_METRIC_LP_FEES_RECEIVED, DISPATCH_METRIC_MARKET_VALUE, DISPATCH_METRIC_AVERAGE_POSITION, DISPATCH_METRIC_RELATIVE_RETURN, DISPATCH_METRIC_RETURN_VOLATILITY, DISPATCH_METRIC_VALIDATOR_RANKING]

Default value: DISPATCH_METRIC_UNSPECIFIED

totalRewardsEarned Total rewards earned by the individual for the game

totalRewardsEarnedQuantum Total rewards earned by the individual in quantum value

volume Volume traded by the individual

]

teamId ID of the team participating

totalRewardsEarned Total rewards earned by the individual for the team

totalRewardsEarnedQuantum Total rewards earned by the team in quantum value

volume Volume traded by the team

]

]

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.

Example (from schema)

{
  "games": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "epoch": "string",
          "id": "string",
          "individual": {
            "individual": [
              {
                "individual": "string",
                "rank": "string",
                "rewardEarned": "string",
                "rewardEarnedQuantum": "string",
                "rewardMetric": "DISPATCH_METRIC_UNSPECIFIED",
                "totalRewardsEarned": "string",
                "totalRewardsEarnedQuantum": "string",
                "volume": "string"
              }
            ]
          },
          "participants": "string",
          "rewardAssetId": "string",
          "team": {
            "team": [
              {
                "rank": "string",
                "rewardEarned": "string",
                "rewardEarnedQuantum": "string",
                "rewardMetric": "DISPATCH_METRIC_UNSPECIFIED",
                "team": {
                  "membersParticipating": [
                    {
                      "individual": "string",
                      "rank": "string",
                      "rewardEarned": "string",
                      "rewardEarnedQuantum": "string",
                      "rewardMetric": "DISPATCH_METRIC_UNSPECIFIED",
                      "totalRewardsEarned": "string",
                      "totalRewardsEarnedQuantum": "string",
                      "volume": "string"
                    }
                  ],
                  "teamId": "string"
                },
                "totalRewardsEarned": "string",
                "totalRewardsEarnedQuantum": "string",
                "volume": "string"
              }
            ]
          }
        }
      }
    ],
    "pageInfo": {
      "endCursor": "string",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "string"
    }
  }
}

500

An internal server error

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

• curl
• python
• go
• nodejs

• CURL

curl -L -X GET 'https://api.n00.testnet.vega.rocks/api/v2/games' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://api.n00.testnet.vega.rocks

Parameters

gameId — query

epochFrom — query

epochTo — query

entityScope — query

---ENTITY_SCOPE_UNSPECIFIEDENTITY_SCOPE_INDIVIDUALSENTITY_SCOPE_TEAMS

pagination.first — query

pagination.after — query

pagination.last — query

pagination.before — query

pagination.newestFirst — query

---truefalse

ResponseClear

Click the Send API Request button above and see the response here!