Endpoints
- GET /tournaments/{tournament_id}/matches/{match_id}/games
Retrieve the games of one match.
Authorized Access - GET /tournaments/{tournament_id}/matches/{match_id}/games/{number}
Get detailed information about one match game.
Authorized Access - PATCH /tournaments/{tournament_id}/matches/{match_id}/games/{number}
Update information about one match game.
Authorized Access
GET /tournaments/{tournament_id}/matches/{match_id}/games
Returns the games of the given match. If the game type is "ffa", this list is limited to the first 4 opponents ordered by their position.
Resource URL
https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/matches/{match_id}/games
HTTP headers
- X-Api-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:result
scope (see Authorization) - Rangestring
A range of requested items using the
games
unit. The size of the range cannot exceed 50. (see Pagination)Example: games=0-49
Path parameters
- tournament_idstring
The id of the match's tournament.
Example: 378426939508809728
- match_idstring
The id of the match.
Example: 212738912376478976
Query Parameters
This endpoint doesn't have any query parameters.
Request Body
This endpoint doesn't require a request body.
Response
[200] Success
Example
[ { "number": 1, "status": "completed", "opponents": [ { "number": 1, "position": 1, "result": "win", "rank": 3, "forfeit": false, "score": 15 } ] } ]
Structure (collection)
- numberinteger
The game number (a relative identifier within a match)
Example: 1
- statusstring
Set's status: "pending" means it hasn’t started yet; "running" means it has started but not ended yet; "completed" indicates the game is finished.
Possible values: pending, running, completed
- opponentsarray[object]
List of the opponents involved in this match-game.
GET /tournaments/{tournament_id}/matches/{match_id}/games/{number}
Returns detailed information about one match game.
Resource URL
https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/matches/{match_id}/games/{number}
HTTP headers
- X-Api-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:result
scope (see Authorization)
Path parameters
- tournament_idstring
The id of the match's tournament.
Example: 378426939508809728
- match_idstring
The id of the match.
Example: 212738912376478976
- numberinteger
The game number of the match
Example: 1
Query Parameters
This endpoint doesn't have any query parameters.
Request Body
This endpoint doesn't require a request body.
Response
[200] Success
Example
{ "number": 1, "status": "completed", "opponents": [ { "number": 1, "position": 1, "result": "win", "rank": 3, "forfeit": false, "score": 15, "properties": { "class": "druid" } } ], "properties": { "map": "de_dust2" } }
Structure (object)
- numberinteger
The game number (a relative identifier within a match)
Example: 1
- statusstring
Set's status: "pending" means it hasn’t started yet; "running" means it has started but not ended yet; "completed" indicates the game is finished.
Possible values: pending, running, completed
- opponentsarray[object]
List of the opponents involved in this match-game.
- propertiesobject
Features of the game that was played.
Example: {"map":"de_dust2"}
PATCH /tournaments/{tournament_id}/matches/{match_id}/games/{number}
Update information about one match game.
Resource URL
https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/matches/{match_id}/games/{number}
HTTP headers
- X-Api-Keystring
API key of your application (see Authentication)
- Authorizationstring
Access token with
organizer:result
scope (see Authorization)
Path parameters
- tournament_idstring
The id of the match's tournament.
Example: 378426939508809728
- match_idstring
The id of the match.
Example: 212738912376478976
- numberinteger
The game number of the match
Example: 1
Query Parameters
This endpoint doesn't have any query parameters.
Request Body
Match game information
Example
{ "properties": { "map": "de_dust2" } }
Structure (object)
- statusstring|null
Optional
The status of the game, set to NULL for an automatic update of the status.
Possible values: pending, running, completed
- opponentsarray[object]
Optional
List of the opponents involved in this match-game.
- propertiesobject
Optional
Features of the game that was played.
Example: {"map":"de_dust2"}
Response
[200] Success
Example
{ "number": 1, "status": "completed", "opponents": [ { "number": 1, "position": 1, "result": "win", "rank": 3, "forfeit": false, "score": 15, "properties": { "class": "druid" } } ], "properties": { "map": "de_dust2" } }
Structure (object)
- numberinteger
The game number (a relative identifier within a match)
Example: 1
- statusstring
Set's status: "pending" means it hasn’t started yet; "running" means it has started but not ended yet; "completed" indicates the game is finished.
Possible values: pending, running, completed
- opponentsarray[object]
List of the opponents involved in this match-game.
- propertiesobject
Features of the game that was played.
Example: {"map":"de_dust2"}