List games
GEThttps://api.testnet.vega.rocks/api/v2/games
Get a list of games and corresponding game data, given the provided filters
Request
Query Parameters
- 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
Game ID to filter for.
Oldest epoch to retrieve game data from, inclusive. The maximum range of epochs that can be fetched at once is 30. If not provided, defaults to the 'to' epoch minus 29, or the first epoch available if not enough epochs have passed. If the 'to' epoch is not specified, it will be set to the chosen 'from' epoch + 29.
Most recent epoch to retrieve game data to, inclusive. If not provided, defaults to the latest epoch. The maximum range of epochs that can be fetched at once is 30. If no 'from' epoch is provided, or the 'from' epoch is out of range, i.e., the 'to' epoch - 'from' epoch > 29, the 'from' epoch will be set to the 'to' epoch - 29.
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.
Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.
If paging forwards, the cursor string for the last row of the previous page.
Number of records to be returned that sort less than row identified by cursor supplied in 'before'.
If paging forwards, the cursor string for the first row of the previous page.
Whether to order the results with the newest records first. If not set, the default value is true.
Team ID to filter for. This filter will only be applied if entity scope is not specified in the request, or the entity scope is set to teams.
Party ID to filter for. This filter will apply regardless of the entity scope. If the entity scope filter is teams, then the party ID filter will apply to team members.
Responses
- 200
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
games object
{
"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"
}
}
}
An internal server error
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}
- curl
- python
- go
- nodejs
- CURL
curl -L 'https://api.testnet.vega.rocks/api/v2/games' \
-H 'Accept: application/json'