Viewer API › Match Games Legacy

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

Returns detailed information about one match game.

Resource URL

https://api.toornament.com/viewer/v2/tournaments/{tournament_id}/matches/{match_id}/games/{number}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

Path parameters

• tournament_id

  string

  The id of the tournament you want to retrieve data about.

• match_id

  string

  The id of the match to retrieve.

• 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] Game retrieved.

Example

{
    "number": 1,
    "type": "duel",
    "status": "pending",
    "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

• type

  string

  The match game type.

  Possible values: duel, ffa

• status

  string

  The status of the match game.

  Possible values: pending, running, completed

• opponents

  array[object]

  List of match game opponents.

  • number

    integer

    A relative identifier between 1 and the total number of participants, it is unique and determined by the seeding.

    Example: 1

  • position

    integer

    The position of the participant in the ranking. It is unique and tied participants have their position determined by their number.

    Example: 1

  • result

    string|null

    The game result of the opponent.

    Possible values: win, draw, loss

  • rank

    integer|null

    The rank of the participant in the ranking. Multiple participants can share the same rank if they are tied after applying all configured tiebreakers.

    Example: 3

  • forfeit

    boolean

    Whether the opponent is forfeit.

    Example: false

  • score

    integer|null

    The score of the opponent.

    Example: 15

  • properties

    object

    Opponent properties depending on the discipline features (champion, spells...).

    Example: {}

• properties

  object

  Discipline features that define the specificities of the match game (map, gamemode...).

  Example: {}