Competier
  • api-key
  • ladder
  • ladder-entry
  • result
    • Adds a game result for a played game.POST
    • Deletes a game result by rolling it back, reverting rating changes.DELETE
    • Gets game results.GET
  • invite
  • account
  • credit
  • websocket
logoPowered by Apidog
  1. result

Gets game results.

GET/v1/results

Gets game results. By default, results for all ladders that the querying user has participated in are returned.

Request

Authorization: Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example
Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379
Query Params
amount
array[integer]
optional

Amount of latest game results to get. Default and maximum is 10.

offset
array[integer]
optional

Amount of latest game results to skip. For example, if you have already populated a match history with the 10 latest results, but then your user wants to also see the previous 10 results, you would fetch those using offset=10.

ladderId
array[integer]
optional

Only get your results for the ladder with this id. Mutually exclusive with ladderEntryId.

allLadderEntries
array[boolean]
optional

Get results for all ladder entries of the given ladderId. Only usable by admins or if the allowFullResultHistory permission is set for the ladder. Mutually exclusive with ladderEntryId.

ladderEntryId
array[integer]
optional

Only get results in which the ladderEntry with this id participated. Only usable by admins or if the respective permission has been set for the ladder. Mutually exclusive with ladderId.

Request samples

Responses

OK(200)
Bad request(400)
Unauthorized(401)
Too Many Requests(429)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
array of:
id
number 
read-onlyoptional

References a result.

Example:
0
ladderId
integer 
optional

Id of the ladder to be referenced. A result must have either a ladderId or a tournamentId.

Example:
0
tournamentId
integer 
optional

Currently unused

ladderEntryIds
array[integer]
required

IDs of all ladder-entries that have participated in this game.

Example:
[123,42,13,7]
entryNames
array[string]
read-onlyoptional

Names of all ladder-entries that have participated in this game. Name changes after this game happened are not reflected.

Example:
["Alice","Bob","Charlie","Dave"]
entryTeams
array[integer]
optional

Defines teams for the given ladderEntryIds. Members of the same team won't be considered to be playing against each other during rating calculation. In the example case, the ladder entry with the ID 123 is in team 1, 42 is in team 3, and 13 and 7 are in team 2. If some entries are in teams but others aren't, you can use team -1 for those that aren't, instead of giving each their own team. Can be omitted if there are no teams.

Example:
[1,3,2,2]
finishPositions
array[integer]
required

Describes the game's result for the given ladderEntryIds. In the example case, the ladder entry with the ID 123 has won, 42 has come 2nd, and 13 and 7 share a 3rd place. These results are used for rating calculation.

Example:
[1,2,3,3]
oldRatings
array[integer]
read-onlyoptional

Ratings for the given ladderEntryIds before ratingChanges caused by this result were applied.

Example:
[1500,1500,1500,1800]
ratingChanges
array[integer]
read-onlyoptional

Rating changes for the given ladderEntryIds caused by this result.

Example:
[29,3,-12,-20]
reliabilityDeviationChanges
array[integer]
read-onlyoptional

Reliability deviation changes for the given ladderEntryIds caused by this result. This doesn't include reliability deviation increases caused by not having played an

Example:
[123,123,123,123]
volatilityChanges
array[integer]
read-onlyoptional

Currently unused

data
string 
optional

Any additional JSON with data you would like to store for this result. This will be returned as is when you GET this result.

Example:
Example
Not configured
Last modified: 9 months ago