Matches

GET /tournaments/{tournament_id}/matches

Simple Access

Returns the matches of a tournament. In ffa matches only the first four opponents are included in each match.

Resource URL

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

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Range
    string

    A range of requested items using the matches unit. The size of the range can not exceed 128. (see Pagination)

    Example: matches=0-127

Path parameters

  • tournament_id
    string

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

Query Parameters

  • stage_ids
    array

    One or several stage ids to filter.

    Example: 618965765764577354,618931468547654563

  • stage_numbers
    array

    One or several stage numbers to filter.

    Example: 1,3

  • group_ids
    array

    One or several group ids to filter.

    Example: 618965314871946714,618932178746476544

  • group_numbers
    array

    One or several group numbers to filter.

    Example: 2,4

  • round_ids
    array

    One or several round ids to filter.

    Example: 618943519431786343,618965178941654763

  • round_numbers
    array

    One or several round numbers to filter.

    Example: 1,2

  • statuses
    array

    One or several match statuses to filter.

    Example: pending,running

  • is_scheduled
    boolean

    Whether to include scheduled matches.

    Possible values: 0, 1

  • scheduled_before
    string

    A datetime in RFC 3339 format (combined date, time and utc offset), to include all matches scheduled before or at the datetime.

    Format: datetime

    Example: 2015-12-31T00:00:00+00:00

  • scheduled_after
    string

    A datetime in RFC 3339 format (combined date, time and utc offset), to include all matches scheduled after or at the datetime

    Format: datetime

    Example: 2015-12-31T00:00:00+00:00

  • participant_ids
    array

    One or several participant ids involved in the matches to filter.

    Example: 618965416546776434,618975467354349191

  • sort
    string

    A method to sort the filtered data. "structure" sorts using the stage, group, round and match numbers. "schedule" sorts using the scheduled date. "latest results" sorts using the date at which the matches were played (not scheduled).

    Possible values: structure, schedule, latest_results

    Default: structure

Request Body

This endpoint does not require a request body.

Response

[206] Matches retrieved.

Example
[
    {
        "id": "618954615761465416",
        "stage_id": "618983668512789184",
        "group_id": "618985165765456465",
        "round_id": "618965146546456651",
        "number": 2,
        "type": "duel",
        "status": "pending",
        "scheduled_datetime": "2015-12-31T00:00:00+00:00",
        "played_at": "2015-12-31T00:00:00+00:00",
        "opponents": [
            {
                "number": 1,
                "position": 1,
                "result": "win",
                "rank": 3,
                "forfeit": false,
                "score": 15,
                "participant": {
                    "id": "375143143408309123",
                    "name": "Northmen",
                    "custom_fields": {}
                }
            }
        ]
    }
]
Structure (collection)
  • id
    string

    The id of the match.

    Example: "618954615761465416"

  • stage_id
    string

    The id of the stage that contains this match.

    Example: "618983668512789184"

  • group_id
    string

    The id of the group that contains this match.

    Example: "618985165765456465"

  • round_id
    string

    The id of the round that contains this match.

    Example: "618965146546456651"

  • number
    integer

    The match number (a relative identifier within a round).

    Example: 2

  • type
    string

    The match type.

    Possible values: duel, ffa, bye

  • status
    string

    The status of the match.

    Possible values: pending, running, completed

  • scheduled_datetime
    string|null

    The scheduled date of the match in RFC 3339 (combined date, time and utc offset).

    Format: datetime

    Example: "2015-12-31T00:00:00+00:00"

  • played_at
    string|null

    The timestamp on which the match was played (a result was provided) in RFC 3339 (combined date, time and utc offset).

    Format: datetime

    Example: "2015-12-31T00:00:00+00:00"

  • opponents
    array[object]

    List of match opponents.

GET /tournaments/{tournament_id}/matches/{id}

Simple Access

Returns a match with all its games and opponents. In ffa matches only the first four opponents are included in each match game.

Resource URL

https://api.toornament.com/viewer/v2/tournaments/{tournament_id}/matches/{id}

HTTP headers

Path parameters

  • tournament_id
    string

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

  • id
    string

    The id of the match to retrieve.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Match retrieved.

Example
{
    "id": "618954615761465416",
    "stage_id": "618983668512789184",
    "group_id": "618985165765456465",
    "round_id": "618965146546456651",
    "number": 2,
    "type": "duel",
    "status": "pending",
    "scheduled_datetime": "2015-12-31T00:00:00+00:00",
    "played_at": "2015-12-31T00:00:00+00:00",
    "opponents": [
        {
            "number": 1,
            "position": 1,
            "result": "win",
            "rank": 3,
            "forfeit": false,
            "score": 15,
            "participant": {
                "id": "375143143408309123",
                "name": "Northmen",
                "custom_fields": {}
            }
        }
    ],
    "public_note": "A note on\\ntwo lines\\n",
    "games": [
        {
            "number": 1,
            "status": "pending",
            "opponents": [
                {
                    "number": 1,
                    "position": 1,
                    "result": "win",
                    "rank": 3,
                    "forfeit": false,
                    "score": 15
                }
            ]
        }
    ]
}
Structure (object)
  • id
    string

    The id of the match.

    Example: "618954615761465416"

  • stage_id
    string

    The id of the stage that contains this match.

    Example: "618983668512789184"

  • group_id
    string

    The id of the group that contains this match.

    Example: "618985165765456465"

  • round_id
    string

    The id of the round that contains this match.

    Example: "618965146546456651"

  • number
    integer

    The match number (a relative identifier within a round).

    Example: 2

  • type
    string

    The match type.

    Possible values: duel, ffa, bye

  • status
    string

    The status of the match.

    Possible values: pending, running, completed

  • scheduled_datetime
    string|null

    The scheduled date of the match in RFC 3339 (combined date, time and utc offset).

    Format: datetime

    Example: "2015-12-31T00:00:00+00:00"

  • played_at
    string|null

    The timestamp on which the match was played (a result was provided) in RFC 3339 (combined date, time and utc offset).

    Format: datetime

    Example: "2015-12-31T00:00:00+00:00"

  • opponents
    array[object]

    List of match opponents.

  • public_note
    string|null

    Public note of a match, written by the organizer.

    Example: "A note on\ntwo lines\n"

  • games
    array[object]

    List of the match games.

GET /disciplines/{discipline_id}/matches

Simple Access

Returns matches of a discipline. In ffa matches only the first four opponents are included in each match game.

Resource URL

https://api.toornament.com/viewer/v2/disciplines/{discipline_id}/matches

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Range
    string

    A range of requested items using the matches unit. The size of the range can not exceed 128. (see Pagination)

    Example: matches=0-127

Path parameters

  • discipline_id
    string

    The string id of the discipline.

Query Parameters

  • is_featured
    boolean

    Whether to include featured tournaments.

    Possible values: 0, 1

  • statuses
    array

    One or several match statuses to filter.

    Example: pending,running

  • scheduled_before
    string

    A datetime in RFC 3339 format (combined date, time and utc offset), to include all matches scheduled before or at the datetime.

    Format: datetime

    Example: 2015-12-31T00:00:00+00:00

  • scheduled_after
    string

    A datetime in RFC 3339 format (combined date, time and utc offset), to include all matches scheduled after or at the datetime

    Format: datetime

    Example: 2015-12-31T00:00:00+00:00

  • participant_ids
    array

    One or several participant ids involved in the matches to filter.

    Example: 618965416546776434,618975467354349191

  • tournament_ids
    array

    List of tournament IDs to filter the data with.

    Example: 618965416546776434,618975467354349191

  • sort
    string

    A method to sort the filtered data. "structure" sorts using the stage, group, round and match numbers. "schedule" sorts using the scheduled date. "latest results" sorts using the date at which the matches were played (not scheduled).

    Possible values: structure, schedule, latest_results

    Default: structure

Request Body

This endpoint does not require a request body.

Response

[206] Matches retrieved.

Example
[
    {
        "id": "618954615761465416",
        "stage_id": "618983668512789184",
        "group_id": "618985165765456465",
        "round_id": "618965146546456651",
        "number": 2,
        "type": "duel",
        "status": "pending",
        "scheduled_datetime": "2015-12-31T00:00:00+00:00",
        "played_at": "2015-12-31T00:00:00+00:00",
        "opponents": [
            {
                "number": 1,
                "position": 1,
                "result": "win",
                "rank": 3,
                "forfeit": false,
                "score": 15,
                "participant": {
                    "id": "375143143408309123",
                    "name": "Northmen",
                    "custom_fields": {}
                }
            }
        ],
        "tournament": {
            "id": "378426939508809728",
            "name": "My Weekly Tournament",
            "full_name": "My Weekly Tournament - Long title"
        }
    }
]
Structure (collection)
  • id
    string

    The id of the match.

    Example: "618954615761465416"

  • stage_id
    string

    The id of the stage that contains this match.

    Example: "618983668512789184"

  • group_id
    string

    The id of the group that contains this match.

    Example: "618985165765456465"

  • round_id
    string

    The id of the round that contains this match.

    Example: "618965146546456651"

  • number
    integer

    The match number (a relative identifier within a round).

    Example: 2

  • type
    string

    The match type.

    Possible values: duel, ffa, bye

  • status
    string

    The status of the match.

    Possible values: pending, running, completed

  • scheduled_datetime
    string|null

    The scheduled date of the match in RFC 3339 (combined date, time and utc offset).

    Format: datetime

    Example: "2015-12-31T00:00:00+00:00"

  • played_at
    string|null

    The timestamp on which the match was played (a result was provided) in RFC 3339 (combined date, time and utc offset).

    Format: datetime

    Example: "2015-12-31T00:00:00+00:00"

  • opponents
    array[object]

    List of match opponents.

  • tournament
    object

    The tournament the match is a part of.