List game party scores
GET/api/v2/games/party-scores
Get a list of party scores for the given filters
Request
Query Parameters
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.
Restrict game scores to those in the given games.
Restrict game scores to the parties in the given teams.
Restrict game scores to those relating to the given parties.
Restrict game scores to those from a given epoch.
Restrict game scores to those up to a given epoch.
Responses
- 200
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
partyScores object
Page of party game scores data and corresponding page information.
edges object[]
Page of orders and their corresponding cursors.
Cursor that can be used to fetch further pages.
node object
Data associated with an order submitted to a Vega node.
Epoch when these scores were generated.
Game ID.
If the party is eligible for a reward for this game based on the current information.
Party's current open volume. Only populated if the game has a requirement for it.
The party ID.
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.
Party's current score in the game.
Party's current staking balance. Only populated if the game has a requirement for it.
Team the party belongs to. Unset if the party is not part of a team.
Timestamp in Unix nanoseconds when these scores were generated.
Total fees paid by the party during the relevant period.
pageInfo object
Page information that is used for fetching further pages.
End cursor.
Indicator if there is a next page.
Indicator if there is a previous page.
Start cursor.
{
"partyScores": {
"edges": [
{
"cursor": "string",
"node": {
"epoch": "string",
"gameId": "string",
"isEligible": true,
"openVolume": "string",
"party": "string",
"rank": "string",
"score": "string",
"stakingBalance": "string",
"teamId": "string",
"time": "string",
"totalFeesPaid": "string"
}
}
],
"pageInfo": {
"endCursor": "string",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "string"
}
}
}
An internal server error
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- 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.)
- ]
details object[]
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:
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.
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- 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.)
- ]
details object[]
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:
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.
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}