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/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 cannot exceed 50. (see Pagination)

  Example: games=0-49

Path parameters

• tournament_id

  string

  The id of the match's tournament.

  Example: 378426939508809728

• match_id

  string

  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)

• number

  integer

  The game number (a relative identifier within a match)

  Example: 1

• status

  string

  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

• 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

    Optional

    The match-game result of the opponent (only for duel type)

    Possible values: win, draw, loss

  • rank

    integer|null

    Optional

    The match rank of the opponent (only for ffa type)

    Example: 3

  • forfeit

    boolean

    Whether the opponent is forfeit

    Example: false

  • score

    integer|null

    The score of the opponent

    Example: 15

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-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 match's tournament.

  Example: 378426939508809728

• match_id

  string

  The id of the match.

  Example: 212738912376478976

• number

  integer

  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)

• number

  integer

  The game number (a relative identifier within a match)

  Example: 1

• status

  string

  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

• 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

    Optional

    The match-game result of the opponent (only for duel type)

    Possible values: win, draw, loss

  • rank

    integer|null

    Optional

    The match rank of the opponent (only for ffa type)

    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: {"class":"druid"}

• properties

  object

  Features of the game that was played.

  Example: {"map":"de_dust2"}

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-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 match's tournament.

  Example: 378426939508809728

• match_id

  string

  The id of the match.

  Example: 212738912376478976

• number

  integer

  The game number of the match

  Example: 1

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

Match game information

Example

{
    "status": null,
    "opponents": [
        {
            "number": 1,
            "position": 1,
            "result": "win",
            "rank": 3,
            "forfeit": false,
            "score": 15,
            "properties": {
                "class": "druid"
            }
        }
    ],
    "properties": {
        "map": "de_dust2"
    }
}

Structure (object)

• status

  string|null

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

  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

    Optional

    The match-game result of the opponent (only for duel type)

    Possible values: win, draw, loss

  • rank

    integer|null

    Optional

    The match rank of the opponent (only for ffa type)

    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: {"class":"druid"}

• properties

  object

  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)

• number

  integer

  The game number (a relative identifier within a match)

  Example: 1

• status

  string

  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

• 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

    Optional

    The match-game result of the opponent (only for duel type)

    Possible values: win, draw, loss

  • rank

    integer|null

    Optional

    The match rank of the opponent (only for ffa type)

    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: {"class":"druid"}

• properties

  object

  Features of the game that was played.

  Example: {"map":"de_dust2"}