Match API › Match 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-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:result scope (see Authorization)

• Range

  string

  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_id

  string

  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

[
    {
        "number": 1,
        "status": "completed",
        "opponents": [
            {
                "number": 1,
                "position": 1,
                "result": "win",
                "rank": 3,
                "forfeit": false,
                "score": 15
            }
        ]
    }
]

Structure (collection)

• number

  integer

  A relative identifier between 1 and the total number of games, to identify the game within the match.

  Example: 1

• status

  string

  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

• opponents

  array[object]

  List of the opponents involved in this match-game.

  • number

    integer

    Optional

    The match-game opponent number (a relative identifier within a match).

    Example: 1

  • position

    integer

    Optional

    The match-game opponent position (calculate by internal processes).

    Example: 1

  • result

    string|null

    Optional

    The match-game result of the opponent.

    Possible values: win, draw, loss

  • rank

    integer|null

    Optional

    The match rank of the opponent.

    Example: 3

  • forfeit

    boolean

    Optional

    Whether the opponent is forfeit.

    Example: false

  • score

    integer|null

    Optional

    The score of the opponent.

    Example: 15

Returns detailed information about one match game.

Resource URL

https://api.toornament.com/organizer/v2/matches/{match_id}/games/{number}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:result scope (see Authorization)

Path parameters

• match_id

  string

  The id of the match.

• number

  string

  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

{
    "number": 1,
    "status": "completed",
    "opponents": [
        {
            "number": 1,
            "position": 1,
            "result": "win",
            "rank": 3,
            "forfeit": false,
            "score": 15,
            "properties": {}
        }
    ],
    "properties": {}
}

Structure (object)

• number

  integer

  A relative identifier between 1 and the total number of games, to identify the game within the match.

  Example: 1

• status

  string

  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

• opponents

  array[object]

  List of the opponents involved in this match-game.

  • number

    integer

    The match-game opponent number (a relative identifier within a match).

    Example: 1

  • position

    integer

    The match-game opponent position (calculate by internal processes).

    Example: 1

  • result

    string|null

    The match-game result of the opponent.

    Possible values: win, draw, loss

  • rank

    integer|null

    The match rank of the opponent.

    Example: 3

  • forfeit

    boolean

    Whether the opponent is forfeit.

    Example: false

  • score

    integer|null

    The score of the opponent.

    Example: 15

  • properties

    object

    Features of the game played by the opponent.

    Example: {}

• properties

  object

  Discipline features that define the specifics of the match game.

  Example: {}

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-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:result scope (see Authorization)

Path parameters

• match_id

  string

  The id of the match.

• number

  string

  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)

• status

  string|null

  Optional

  The status of the game, set to NULL for an automatic update of the status.

  Possible values: pending, running, completed

• opponents

  array[object]

  Optional

  List of the opponents involved in this match-game.

  • number

    integer

    Optional

    The match-game opponent number (a relative identifier within a match).

    Example: 1

  • position

    integer

    Optional

    The match-game opponent position (calculate by internal processes).

    Example: 1

  • result

    string|null

    Optional

    The match-game result of the opponent.

    Possible values: win, draw, loss

  • rank

    integer|null

    Optional

    The match rank of the opponent.

    Example: 3

  • forfeit

    boolean

    Optional

    Whether the opponent is forfeit.

    Example: false

  • score

    integer|null

    Optional

    The score of the opponent.

    Example: 15

  • properties

    object

    Optional

    Features of the game played by the opponent.

    Example: {}

• properties

  object

  Optional

  Discipline features that define the specifics of the match game.

  Example: {}

Response

[200] Success

Example

{
    "number": 1,
    "status": "completed",
    "opponents": [
        {
            "number": 1,
            "position": 1,
            "result": "win",
            "rank": 3,
            "forfeit": false,
            "score": 15,
            "properties": {}
        }
    ],
    "properties": {}
}

Structure (object)

• number

  integer

  A relative identifier between 1 and the total number of games, to identify the game within the match.

  Example: 1

• status

  string

  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

• opponents

  array[object]

  List of the opponents involved in this match-game.

  • number

    integer

    The match-game opponent number (a relative identifier within a match).

    Example: 1

  • position

    integer

    The match-game opponent position (calculate by internal processes).

    Example: 1

  • result

    string|null

    The match-game result of the opponent.

    Possible values: win, draw, loss

  • rank

    integer|null

    The match rank of the opponent.

    Example: 3

  • forfeit

    boolean

    Whether the opponent is forfeit.

    Example: false

  • score

    integer|null

    The score of the opponent.

    Example: 15

  • properties

    object

    Features of the game played by the opponent.

    Example: {}

• properties

  object

  Discipline features that define the specifics of the match game.

  Example: {}

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

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-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:result scope (see Authorization)

• Range

  string

  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_id

  string

  The id of the tournament.

• match_id

  string

  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

[
    {
        "number": 1,
        "status": "completed",
        "opponents": [
            {
                "number": 1,
                "position": 1,
                "result": "win",
                "rank": 3,
                "forfeit": false,
                "score": 15
            }
        ]
    }
]

Structure (collection)

• number

  integer

  A relative identifier between 1 and the total number of games, to identify the game within the match.

  Example: 1

• status

  string

  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

• opponents

  array[object]

  List of the opponents involved in this match-game.

  • number

    integer

    Optional

    The match-game opponent number (a relative identifier within a match).

    Example: 1

  • position

    integer

    Optional

    The match-game opponent position (calculate by internal processes).

    Example: 1

  • result

    string|null

    Optional

    The match-game result of the opponent.

    Possible values: win, draw, loss

  • rank

    integer|null

    Optional

    The match rank of the opponent.

    Example: 3

  • forfeit

    boolean

    Optional

    Whether the opponent is forfeit.

    Example: false

  • score

    integer|null

    Optional

    The score of the opponent.

    Example: 15

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

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-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:result scope (see Authorization)

Path parameters

• tournament_id

  string

  The id of the tournament.

• match_id

  string

  The id of the match.

• number

  string

  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

{
    "number": 1,
    "status": "completed",
    "opponents": [
        {
            "number": 1,
            "position": 1,
            "result": "win",
            "rank": 3,
            "forfeit": false,
            "score": 15,
            "properties": {}
        }
    ],
    "properties": {}
}

Structure (object)

• number

  integer

  A relative identifier between 1 and the total number of games, to identify the game within the match.

  Example: 1

• status

  string

  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

• opponents

  array[object]

  List of the opponents involved in this match-game.

  • number

    integer

    The match-game opponent number (a relative identifier within a match).

    Example: 1

  • position

    integer

    The match-game opponent position (calculate by internal processes).

    Example: 1

  • result

    string|null

    The match-game result of the opponent.

    Possible values: win, draw, loss

  • rank

    integer|null

    The match rank of the opponent.

    Example: 3

  • forfeit

    boolean

    Whether the opponent is forfeit.

    Example: false

  • score

    integer|null

    The score of the opponent.

    Example: 15

  • properties

    object

    Features of the game played by the opponent.

    Example: {}

• properties

  object

  Discipline features that define the specifics of the match game.

  Example: {}

This endpoint is in legacy mode. Access will soon be deprecated. It is therefore advised to use another endpoint when possible.

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-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:result scope (see Authorization)

Path parameters

• tournament_id

  string

  The id of the tournament.

• match_id

  string

  The id of the match.

• number

  string

  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)

• status

  string|null

  Optional

  The status of the game, set to NULL for an automatic update of the status.

  Possible values: pending, running, completed

• opponents

  array[object]

  Optional

  List of the opponents involved in this match-game.

  • number

    integer

    Optional

    The match-game opponent number (a relative identifier within a match).

    Example: 1

  • position

    integer

    Optional

    The match-game opponent position (calculate by internal processes).

    Example: 1

  • result

    string|null

    Optional

    The match-game result of the opponent.

    Possible values: win, draw, loss

  • rank

    integer|null

    Optional

    The match rank of the opponent.

    Example: 3

  • forfeit

    boolean

    Optional

    Whether the opponent is forfeit.

    Example: false

  • score

    integer|null

    Optional

    The score of the opponent.

    Example: 15

  • properties

    object

    Optional

    Features of the game played by the opponent.

    Example: {}

• properties

  object

  Optional

  Discipline features that define the specifics of the match game.

  Example: {}

Response

[200] Success

Example

{
    "number": 1,
    "status": "completed",
    "opponents": [
        {
            "number": 1,
            "position": 1,
            "result": "win",
            "rank": 3,
            "forfeit": false,
            "score": 15,
            "properties": {}
        }
    ],
    "properties": {}
}

Structure (object)

• number

  integer

  A relative identifier between 1 and the total number of games, to identify the game within the match.

  Example: 1

• status

  string

  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

• opponents

  array[object]

  List of the opponents involved in this match-game.

  • number

    integer

    The match-game opponent number (a relative identifier within a match).

    Example: 1

  • position

    integer

    The match-game opponent position (calculate by internal processes).

    Example: 1

  • result

    string|null

    The match-game result of the opponent.

    Possible values: win, draw, loss

  • rank

    integer|null

    The match rank of the opponent.

    Example: 3

  • forfeit

    boolean

    Whether the opponent is forfeit.

    Example: false

  • score

    integer|null

    The score of the opponent.

    Example: 15

  • properties

    object

    Features of the game played by the opponent.

    Example: {}

• properties

  object

  Discipline features that define the specifics of the match game.

  Example: {}