Download OpenAPI specification:Download
This API provides access to matchmaking.
Authentication with this API is achieved using tokens. To retrieve a token, send a POST request to
https://cognito-idp.eu-central-1.amazonaws.com/
X-Amz-Target: AWSCognitoIdentityProviderService.InitiateAuth
Content-Type: application/x-amz-json-1.1
{"AuthParameters":{"USERNAME": "<your username>","PASSWORD":"<your-password>"},"AuthFlow":"USER_PASSWORD_AUTH","ClientId":"3ns1sc0lkrdqh25qvrqb9k3a80"}
The response contains an IdToken
in the AuthenticationResult
. This token is to be used for the Authorization
header on all requests of this API.
/games/{gameId}/players
/games/{gameId}/matches
/games/{gameId}/matches/{matchId}/statuses/confirmed
/games/{gameId}/matches/{matchId}/statuses/completed
gameId required | string Id of the game |
partyName | string Optional name of the party |
required | Array of objects (PlayerSubmission) |
{- "partyName": "string",
- "players": [
- {
- "playerId": "string",
- "servers": [
- "string"
], - "reference": "string"
}
]
}
gameId required | string Id of the game |
matchId required | string Id of the match |
remove | Array of strings |
requeue | Array of strings |
{- "remove": [
- "string"
], - "requeue": [
- "string"
]
}
gameId required | string Id of the game |
matchId required | string Id of the match |
server | string |
gameLength | number |
required | Array of objects (TeamRankingSubmission) |
{- "server": "string",
- "gameLength": 0,
- "teams": [
- {
- "rank": 0,
- "players": [
- {
- "playerId": "string",
- "score": 0
}
]
}
]
}
{- "players": [
- {
- "playerId": "string",
- "rating": 0,
- "ratingUncertainty": 0,
- "rankingPoints": 0,
- "ratingDeltaLastGame": 0,
- "rankingDeltaLastGame": 0,
- "wins": 0,
- "losses": 0,
- "matchesPlayed": 0,
- "winRatio": 0,
- "seasonWins": 0,
- "seasonLosses": 0,
- "seasonMatchesPlayed": 0,
- "totalWins": 0,
- "totalLosses": 0,
- "totalMatchesPlayed": 0,
- "season": "string"
}
]
}
playerId required | string Player ID |
{- "playerId": "string",
- "totalWins": 0,
- "totalLosses": 0,
- "totalMatchesPlayed": 0,
- "seasons": [
- {
- "season": "string",
- "seasonWins": 0,
- "seasonLosses": 0,
- "seasonMatchesPlayed": 0,
- "stats": [
- {
- "rating": 0,
- "ratingUncertainty": 0,
- "rankingPoints": 0,
- "wins": 0,
- "losses": 0,
- "matchesPlayed": 0,
- "winRatio": 0,
- "mode": "string"
}
]
}
]
}
gameId required | string Id of the game |
matchId required | string Id of the match |
backfillingRequestId | string |
droppedPlayerId required | string |
Array of objects |
{- "backfillingRequestId": "string",
- "droppedPlayerId": "string",
- "matchScores": [
- {
- "score": 0,
- "players": [
- {
- "playerId": "string",
- "score": 0
}
]
}
]
}
{- "backfillingRequestId": "string"
}