Participant API › Matches Legacy

LegacyGET /me/matches

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

Returns the matches linked to the user associated to the access token. . If the match type is "ffa", the opponents are limited by the first 4 ordered by their position.

Resource URL

https://api.toornament.com/participant/v2/me/matches

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token (see Authorization)

  • Range
    string

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

    Example: matches=0-99

Query Parameters

  • disciplines
    array

    Only return matches for the tournaments with the discipline.

    Example: leagueoflegends,fifa19

  • tournament_ids
    array

    List of tournament IDs to filter the data with.

    Example: 618965416546776434,618975467354349191

  • stage_ids
    array

    One or several stage ids to filter.

    Example: 618965765764577354,618931468547654563

  • group_ids
    array

    One or several group ids to filter.

    Example: 618965314871946714,618932178746476544

  • round_ids
    array

    One or several round ids to filter.

    Example: 618943519431786343,618965178941654763

  • statuses
    array

    One or several match statuses to filter.

    Possible values: pending, running, completed

    Example: pending,running

  • is_scheduled
    boolean

    Whether to include scheduled matches.

    Possible values: 0, 1

  • scheduled_before
    string

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

    Format: datetime

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

  • scheduled_after
    string

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

    Format: datetime

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

  • played_before
    string

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

    Format: datetime

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

  • played_after
    string

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

    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

    Example: schedule

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",
        "settings": {},
        "scheduled_datetime": "2015-12-31T00:00:00+00:00",
        "played_at": "2015-12-31T00:00:00+00:00",
        "public_note": "A note on\\ntwo lines\\n",
        "report_closed": true,
        "opponents": [
            {
                "number": 1,
                "position": 1,
                "result": "win",
                "rank": 3,
                "forfeit": false,
                "score": 15,
                "participant": {
                    "id": "375143143408309123",
                    "name": "Northmen",
                    "custom_fields": {}
                }
            }
        ],
        "tournament_id": "378426939508809728"
    }
]
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|null

    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

  • settings
    object

    Settings that describe the various options related to the match.

    Example: {}

  • scheduled_datetime
    string|null

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

    Format: datetime

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

  • played_at
    string|null

    The date and time when the match was completed (a result was provided).

    Format: datetime

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

  • public_note
    string|null

    Public note of a match, written by the organizer.

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

  • report_closed
    boolean

    Whether the match report is closed.

    Example: true

  • opponents
    array[object]

    List of the opponents involved in this match.

  • tournament_id
    string

    The id of the tournament that contains this match.

    Example: "378426939508809728"

LegacyGET /me/matches/{id}

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

Returns a match by the given id. If the match type is "ffa", a match returns a maximum of 100 opponents.

Resource URL

https://api.toornament.com/participant/v2/me/matches/{id}

HTTP headers

Path parameters

  • id
    string

    The id of the requested custom field.

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",
        "settings": {},
        "scheduled_datetime": "2015-12-31T00:00:00+00:00",
        "played_at": "2015-12-31T00:00:00+00:00",
        "public_note": "A note on\\ntwo lines\\n",
        "report_closed": true,
        "opponents": [
            {
                "number": 1,
                "position": 1,
                "result": "win",
                "rank": 3,
                "forfeit": false,
                "score": 15,
                "participant": {
                    "id": "375143143408309123",
                    "name": "Northmen",
                    "custom_fields": {}
                }
            }
        ],
        "tournament_id": "378426939508809728"
    }
]
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|null

    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

  • settings
    object

    Settings that describe the various options related to the match.

    Example: {}

  • scheduled_datetime
    string|null

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

    Format: datetime

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

  • played_at
    string|null

    The date and time when the match was completed (a result was provided).

    Format: datetime

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

  • public_note
    string|null

    Public note of a match, written by the organizer.

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

  • report_closed
    boolean

    Whether the match report is closed.

    Example: true

  • opponents
    array[object]

    List of the opponents involved in this match.

  • tournament_id
    string

    The id of the tournament that contains this match.

    Example: "378426939508809728"