Endpoints
- GET /tournaments/{tournament_id}/matches/{match_id}/games
Retrieve the games of a match.
Authorized Access - GET /tournaments/{tournament_id}/matches/{match_id}/games/{number}
Retrieve a single game from a match.
Authorized Access - PATCH /tournaments/{tournament_id}/matches/{match_id}/games/{number}
Update information and outcome of a game.
Authorized Access - GET /matches/{match_id}/games
Retrieve the games of one match.
Authorized Access - GET /matches/{match_id}/games/{number}
Get detailed information about one match game.
Authorized Access - PATCH /matches/{match_id}/games/{number}
Update information and outcome of a game.
Authorized Access
GET /tournaments/{tournament_id}/matches/{match_id}/games
Returns the games of the given match. If the match type is "ffa", only the first 4 opponents, ordered by position, are listed in each game.
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 can not exceed 50. (see Pagination)Example: games=0-49
Path parameters
- tournament_idstring
The id of the tournament.
- match_idstring
The id of the match.
Query Parameters
This endpoint does not have any query parameters.
Request Body
This endpoint does not require a request body.
Response
[206] Success
Example
[ { "status": "completed", "opponents": [ { "number": 1, "position": 1, "result": "win", "rank": 3, "forfeit": false, "score": 15 } ], "number": 1 } ]
Structure (collection)
- statusstring
The status of the match game. "Pending" means the game has not started yet. "Running" means the game is ongoing. "Completed" means the game is over.
Possible values: pending, running, completed
- opponentsarray[object]
List of the opponents involved in this match-game.
- numberinteger
A relative identifier between 1 and the total number of games, to identify the game within the match.
Example: 1
GET /tournaments/{tournament_id}/matches/{match_id}/games/{number}
Returns a single game of the given match. A game is limited to 2 participants in "duel" type, and 100 participants in "ffa" type.
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 tournament.
- match_idstring
The id of the match.
- numberstring
The relative identifier of the match game to retrieve.
Query Parameters
This endpoint does not have any query parameters.
Request Body
This endpoint does not require a request body.
Response
[200] Success
Example
{ "status": "completed", "opponents": [ { "number": 1, "position": 1, "result": "win", "rank": 3, "forfeit": false, "score": 15, "properties": {} } ], "number": 1, "properties": {} }
Structure (object)
- statusstring
The status of the match game. "Pending" means the game has not started yet. "Running" means the game is ongoing. "Completed" means the game is over.
Possible values: pending, running, completed
- opponentsarray[object]
List of the opponents involved in this match-game.
- numberinteger
A relative identifier between 1 and the total number of games, to identify the game within the match.
Example: 1
- propertiesobject
Discipline features that define the specifics of the match game.
Example: {}
PATCH /tournaments/{tournament_id}/matches/{match_id}/games/{number}
Updates a single game of the given match. A game is limited to 2 participants in "duel" type, and 100 participants in "ffa" type.
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 tournament.
- match_idstring
The id of the match.
- numberstring
The relative identifier of the match game to retrieve.
Query Parameters
This endpoint does not have any query parameters.
Request Body
Match game data
Example
{ "status": "completed", "opponents": [ { "number": 1, "position": 1, "result": "win", "rank": 3, "forfeit": false, "score": 15, "properties": {} } ], "properties": {} }
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
Discipline features that define the specifics of the match game.
Example: {}
Response
[200] Success
Example
{ "status": "completed", "opponents": [ { "number": 1, "position": 1, "result": "win", "rank": 3, "forfeit": false, "score": 15, "properties": {} } ], "number": 1, "properties": {} }
Structure (object)
- statusstring
The status of the match game. "Pending" means the game has not started yet. "Running" means the game is ongoing. "Completed" means the game is over.
Possible values: pending, running, completed
- opponentsarray[object]
List of the opponents involved in this match-game.
- numberinteger
A relative identifier between 1 and the total number of games, to identify the game within the match.
Example: 1
- propertiesobject
Discipline features that define the specifics of the match game.
Example: {}
GET /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/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 can not exceed 50. (see Pagination)Example: games=0-49
Path parameters
- match_idstring
The id of the match.
Query Parameters
This endpoint does not have any query parameters.
Request Body
This endpoint does not require a request body.
Response
[206] Success
Example
[ { "status": "completed", "opponents": [ { "number": 1, "position": 1, "result": "win", "rank": 3, "forfeit": false, "score": 15 } ], "number": 1 } ]
Structure (collection)
- statusstring
The status of the match game. "Pending" means the game has not started yet. "Running" means the game is ongoing. "Completed" means the game is over.
Possible values: pending, running, completed
- opponentsarray[object]
List of the opponents involved in this match-game.
- numberinteger
A relative identifier between 1 and the total number of games, to identify the game within the match.
Example: 1
GET /matches/{match_id}/games/{number}
Returns detailed information about one match game.
Resource URL
https://api.toornament.com/organizer/v2/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
- match_idstring
The id of the match.
- numberstring
The relative identifier of the match game to retrieve.
Query Parameters
This endpoint does not have any query parameters.
Request Body
This endpoint does not require a request body.
Response
[200] Success
Example
{ "status": "completed", "opponents": [ { "number": 1, "position": 1, "result": "win", "rank": 3, "forfeit": false, "score": 15, "properties": {} } ], "number": 1, "properties": {} }
Structure (object)
- statusstring
The status of the match game. "Pending" means the game has not started yet. "Running" means the game is ongoing. "Completed" means the game is over.
Possible values: pending, running, completed
- opponentsarray[object]
List of the opponents involved in this match-game.
- numberinteger
A relative identifier between 1 and the total number of games, to identify the game within the match.
Example: 1
- propertiesobject
Discipline features that define the specifics of the match game.
Example: {}
PATCH /matches/{match_id}/games/{number}
Updates a single game of the given match. A game is limited to 2 participants in "duel" type, and 100 participants in "ffa" type.
Resource URL
https://api.toornament.com/organizer/v2/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
- match_idstring
The id of the match.
- numberstring
The relative identifier of the match game to retrieve.
Query Parameters
This endpoint does not have any query parameters.
Request Body
Match game data
Example
{ "status": "completed", "opponents": [ { "number": 1, "position": 1, "result": "win", "rank": 3, "forfeit": false, "score": 15, "properties": {} } ], "properties": {} }
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
Discipline features that define the specifics of the match game.
Example: {}
Response
[200] Success
Example
{ "status": "completed", "opponents": [ { "number": 1, "position": 1, "result": "win", "rank": 3, "forfeit": false, "score": 15, "properties": {} } ], "number": 1, "properties": {} }
Structure (object)
- statusstring
The status of the match game. "Pending" means the game has not started yet. "Running" means the game is ongoing. "Completed" means the game is over.
Possible values: pending, running, completed
- opponentsarray[object]
List of the opponents involved in this match-game.
- numberinteger
A relative identifier between 1 and the total number of games, to identify the game within the match.
Example: 1
- propertiesobject
Discipline features that define the specifics of the match game.
Example: {}