Tournaments | Viewer API | API v2.0

Endpoints

LegacyGET /tournaments/featured
Retrieve published featured tournaments.
LegacyGET /tournaments/{id}
Retrieve a single tournament.
LegacyGET /playlists/{id}/tournaments
Retrieve the tournaments of a playlist.

LegacyGET /tournaments/featured

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

Returns a collection of published featured tournaments.

Resource URL

https://api.toornament.com/viewer/v2/tournaments/featured

HTTP headers

X-Api-Key
string
API key of your application (see Authentication)
Range
string
A range of requested items using the tournaments unit. The size of the range can not exceed 50. (see Pagination)
Example: tournaments=0-49

Query Parameters

name
string
The string to be looked for in the name or full name.
disciplines
string
One or several disciplines to filter.
Example: counterstrike_go,fifa17
statuses
string
One or several tournament statuses to filter.
Possible values: pending, running, completed
Example: pending,running
scheduled_before
string
A date to include all tournaments scheduled to take place before or at the date, in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: 2016-12-31
scheduled_after
string
A date to include all tournaments scheduled to take place after or at the date, in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: 2015-12-31
countries
string
One or several countries to filter in ISO 3166-1 alpha-2 country codes format (some codes may not be supported)
Example: US,CA
platforms
string
One or several platforms to filter.
Possible values: pc, playstation4, xbox_one, nintendo_switch, mobile, playstation3, playstation2, playstation1, ps_vita, psp, xbox360, xbox, wii_u, wii, gamecube, nintendo64, snes, nes, dreamcast, saturn, megadrive, master_system, 3ds, ds, game_boy, neo_geo, other_platform, not_video_game
Example: pc,xbox_one,playstation4
is_online
integer
Whether the tournament is played online.
Possible values: 0, 1
sort
string
Sorts the collection in a particular order. "scheduled_asc" sorts the tournaments by scheduled date from the oldest to the most recent one; "scheduled_desc" sorts the tournaments by scheduled date from the most recent to the oldest one.
Possible values: scheduled_asc, scheduled_desc
Default: scheduled_asc

Request Body

This endpoint does not require a request body.

Response

[206] Tournaments retrieved.

Example

[
    {
        "id": "378426939508809728",
        "discipline": "my_discipline",
        "name": "My Weekly Tournament",
        "full_name": "My Weekly Tournament - Long title",
        "status": "running",
        "scheduled_date_start": "2015-09-06",
        "scheduled_date_end": "2015-09-07",
        "timezone": "America\/Sao_Paulo",
        "public": true,
        "size": 16,
        "online": true,
        "location": "London",
        "country": "GB",
        "platforms": [
            "pc",
            "playstation4"
        ],
        "logo": {
            "logo_small": "https:\/\/www.toornament.com\/media\/file\/123456\/logo_small",
            "logo_medium": "https:\/\/www.toornament.com\/media\/file\/123456\/logo_medium",
            "logo_large": "https:\/\/www.toornament.com\/media\/file\/123456\/logo_large",
            "original": "https:\/\/www.toornament.com\/media\/file\/123456\/original"
        },
        "registration_enabled": true,
        "registration_opening_datetime": "1999-01-01T00:00:00+00:00",
        "registration_closing_datetime": "1999-01-01T00:00:00+00:00"
    }
]

Structure (collection)

id
string
The unique identifier of the tournament.
Example: "378426939508809728"
discipline
string
A unique identifier of the tournament’s discipline.
Example: "my_discipline"
name
string
The name of the tournament.
Max. length: 30 characters
Example: "My Weekly Tournament"
full_name
string|null
The complete name of the tournament.
Max. length: 80 characters
Example: "My Weekly Tournament - Long title"
status
string
The status of the tournament
Possible values: pending, running, completed
scheduled_date_start
string|null
A starting date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-06"
scheduled_date_end
string|null
An ending date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-07"
timezone
string
A time zone from the IANA tz database.
Example: "America/Sao_Paulo"
public
boolean
Whether the tournament is published.
Example: true
size
integer
The expected number of participants in the tournament.
Example: 16
online
boolean|null
Whether the tournament is played on internet.
Example: true
location
string|null
The region, city, address or place of interest where the tournament is held.
Example: "London"
country
string|null
The country where the tournament is played. Some codes may not be supported. (format is ISO 3166-1 alpha-2)
Example: "GB"
platforms
array[string]
A list of platforms on which the tournament can be played.
Possible values: pc, playstation4, xbox_one, nintendo_switch, mobile, playstation3, playstation2, playstation1, ps_vita, psp, xbox360, xbox, wii_u, wii, gamecube, nintendo64, snes, nes, dreamcast, saturn, megadrive, master_system, 3ds, ds, game_boy, neo_geo, other_platform, not_video_game
logo
object
- logo_small
  string
  URL of the small version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/logo_small"
- logo_medium
  string
  URL of the medium version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/logo_medium"
- logo_large
  string
  URL of the large version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/logo_large"
- original
  string
  URL of the original version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/original"
registration_enabled
boolean
Whether the registration process is enabled.
Example: true
registration_opening_datetime
string|null
The opening date of the registrations in RFC 3339 format (combined date, time and utc offset)
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
registration_closing_datetime
string|null
The closing date of the registrations in RFC 3339 format (combined date, time and utc offset)
Format: datetime
Example: "1999-01-01T00:00:00+00:00"

LegacyGET /tournaments/{id}

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

Returns a tournament identified with the given id.

Resource URL

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

HTTP headers

X-Api-Key
string
API key of your application (see Authentication)

Path parameters

id
string
The id of the tournament to retrieve.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Tournament retrieved.

Example

{
    "participant_type": "single",
    "organization": "Avery Bullock",
    "contact": "[email protected]",
    "discord": "https:\/\/discord.gg\/blablabla",
    "website": "http:\/\/www.toornament.com",
    "description": "My description \\n on multiple lines",
    "rules": "My rules \\n on multiple lines",
    "prize": "1 - 10,000$ \\n 2 - 5,000$",
    "settings": {},
    "id": "378426939508809728",
    "discipline": "my_discipline",
    "name": "My Weekly Tournament",
    "full_name": "My Weekly Tournament - Long title",
    "status": "running",
    "scheduled_date_start": "2015-09-06",
    "scheduled_date_end": "2015-09-07",
    "timezone": "America\/Sao_Paulo",
    "public": true,
    "size": 16,
    "online": true,
    "location": "London",
    "country": "GB",
    "platforms": [
        "pc",
        "playstation4"
    ],
    "logo": {
        "logo_small": "https:\/\/www.toornament.com\/media\/file\/123456\/logo_small",
        "logo_medium": "https:\/\/www.toornament.com\/media\/file\/123456\/logo_medium",
        "logo_large": "https:\/\/www.toornament.com\/media\/file\/123456\/logo_large",
        "original": "https:\/\/www.toornament.com\/media\/file\/123456\/original"
    },
    "registration_enabled": true,
    "registration_opening_datetime": "1999-01-01T00:00:00+00:00",
    "registration_closing_datetime": "1999-01-01T00:00:00+00:00"
}

Structure (object)

participant_type
string
The type of participants that play in the tournament.
Possible values: team, single
organization
string|null
The name of the organizer, be it an individual, group, association or company.
Example: "Avery Bullock"
contact
string|null
The email address to contact the organizer.
Example: "[email protected]"
discord
string|null
Invite URL to the tournament Discord server.
Example: "https://discord.gg/blablabla"
website
string|null
The tournament's official website URL.
Example: "http://www.toornament.com"
description
string|null
A description of the tournament.
Max. length: 1,500 characters
Example: "My description \n on multiple lines"
rules
string|null
The rules of the tournament.
Max. length: 64,000 characters
Example: "My rules \n on multiple lines"
prize
string|null
The prizes of the tournament.
Max. length: 1,500 characters
Example: "1 - 10,000$ \n 2 - 5,000$"
settings
object
List of tournament settings, it usually contains discipline information for the entire tournament (maps, champions...).
Example: {}
id
string
The unique identifier of the tournament.
Example: "378426939508809728"
discipline
string
A unique identifier of the tournament’s discipline.
Example: "my_discipline"
name
string
The name of the tournament.
Max. length: 30 characters
Example: "My Weekly Tournament"
full_name
string|null
The complete name of the tournament.
Max. length: 80 characters
Example: "My Weekly Tournament - Long title"
status
string
The status of the tournament
Possible values: pending, running, completed
scheduled_date_start
string|null
A starting date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-06"
scheduled_date_end
string|null
An ending date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-07"
timezone
string
A time zone from the IANA tz database.
Example: "America/Sao_Paulo"
public
boolean
Whether the tournament is published.
Example: true
size
integer
The expected number of participants in the tournament.
Example: 16
online
boolean|null
Whether the tournament is played on internet.
Example: true
location
string|null
The region, city, address or place of interest where the tournament is held.
Example: "London"
country
string|null
The country where the tournament is played. Some codes may not be supported. (format is ISO 3166-1 alpha-2)
Example: "GB"
platforms
array[string]
A list of platforms on which the tournament can be played.
Possible values: pc, playstation4, xbox_one, nintendo_switch, mobile, playstation3, playstation2, playstation1, ps_vita, psp, xbox360, xbox, wii_u, wii, gamecube, nintendo64, snes, nes, dreamcast, saturn, megadrive, master_system, 3ds, ds, game_boy, neo_geo, other_platform, not_video_game
logo
object
- logo_small
  string
  URL of the small version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/logo_small"
- logo_medium
  string
  URL of the medium version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/logo_medium"
- logo_large
  string
  URL of the large version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/logo_large"
- original
  string
  URL of the original version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/original"
registration_enabled
boolean
Whether the registration process is enabled.
Example: true
registration_opening_datetime
string|null
The opening date of the registrations in RFC 3339 format (combined date, time and utc offset)
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
registration_closing_datetime
string|null
The closing date of the registrations in RFC 3339 format (combined date, time and utc offset)
Format: datetime
Example: "1999-01-01T00:00:00+00:00"

LegacyGET /playlists/{id}/tournaments

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

Returns the tournaments of a playlist.

Resource URL

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

HTTP headers

X-Api-Key
string
API key of your application (see Authentication)
Range
string
A range of requested items using the tournaments unit. The size of the range can not exceed 50. (see Pagination)
Example: tournaments=0-49

Path parameters

id
string
The string id of the tournament.

Query Parameters

name
string
The string to be looked for in the name or full name.
disciplines
string
One or several disciplines to filter.
Example: counterstrike_go,fifa17
statuses
string
One or several tournament statuses to filter.
Possible values: pending, running, completed
Example: pending,running
scheduled_before
string
A date to include all tournaments scheduled to take place before or at the date, in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: 2016-12-31
scheduled_after
string
A date to include all tournaments scheduled to take place after or at the date, in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: 2015-12-31
countries
string
One or several countries to filter in ISO 3166-1 alpha-2 country codes format (some codes may not be supported)
Example: US,CA
platforms
string
One or several platforms to filter.
Possible values: pc, playstation4, xbox_one, nintendo_switch, mobile, playstation3, playstation2, playstation1, ps_vita, psp, xbox360, xbox, wii_u, wii, gamecube, nintendo64, snes, nes, dreamcast, saturn, megadrive, master_system, 3ds, ds, game_boy, neo_geo, other_platform, not_video_game
Example: pc,xbox_one,playstation4
is_online
integer
Whether the tournament is played online.
Possible values: 0, 1
sort
string
Sorts the collection in a particular order. "scheduled_asc" sorts the tournaments by scheduled date from the oldest to the most recent one; "scheduled_desc" sorts the tournaments by scheduled date from the most recent to the oldest one.
Possible values: scheduled_asc, scheduled_desc
Default: scheduled_asc

Request Body

This endpoint does not require a request body.

Response

[206] Tournaments retrieved.

Example

[
    {
        "id": "378426939508809728",
        "discipline": "my_discipline",
        "name": "My Weekly Tournament",
        "full_name": "My Weekly Tournament - Long title",
        "status": "running",
        "scheduled_date_start": "2015-09-06",
        "scheduled_date_end": "2015-09-07",
        "timezone": "America\/Sao_Paulo",
        "public": true,
        "size": 16,
        "online": true,
        "location": "London",
        "country": "GB",
        "platforms": [
            "pc",
            "playstation4"
        ],
        "logo": {
            "logo_small": "https:\/\/www.toornament.com\/media\/file\/123456\/logo_small",
            "logo_medium": "https:\/\/www.toornament.com\/media\/file\/123456\/logo_medium",
            "logo_large": "https:\/\/www.toornament.com\/media\/file\/123456\/logo_large",
            "original": "https:\/\/www.toornament.com\/media\/file\/123456\/original"
        },
        "registration_enabled": true,
        "registration_opening_datetime": "1999-01-01T00:00:00+00:00",
        "registration_closing_datetime": "1999-01-01T00:00:00+00:00"
    }
]

Structure (collection)

id
string
The unique identifier of the tournament.
Example: "378426939508809728"
discipline
string
A unique identifier of the tournament’s discipline.
Example: "my_discipline"
name
string
The name of the tournament.
Max. length: 30 characters
Example: "My Weekly Tournament"
full_name
string|null
The complete name of the tournament.
Max. length: 80 characters
Example: "My Weekly Tournament - Long title"
status
string
The status of the tournament
Possible values: pending, running, completed
scheduled_date_start
string|null
A starting date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-06"
scheduled_date_end
string|null
An ending date in ISO 8601 format (only the date part, with YYYY-MM-DD pattern).
Format: date
Example: "2015-09-07"
timezone
string
A time zone from the IANA tz database.
Example: "America/Sao_Paulo"
public
boolean
Whether the tournament is published.
Example: true
size
integer
The expected number of participants in the tournament.
Example: 16
online
boolean|null
Whether the tournament is played on internet.
Example: true
location
string|null
The region, city, address or place of interest where the tournament is held.
Example: "London"
country
string|null
The country where the tournament is played. Some codes may not be supported. (format is ISO 3166-1 alpha-2)
Example: "GB"
platforms
array[string]
A list of platforms on which the tournament can be played.
Possible values: pc, playstation4, xbox_one, nintendo_switch, mobile, playstation3, playstation2, playstation1, ps_vita, psp, xbox360, xbox, wii_u, wii, gamecube, nintendo64, snes, nes, dreamcast, saturn, megadrive, master_system, 3ds, ds, game_boy, neo_geo, other_platform, not_video_game
logo
object
- logo_small
  string
  URL of the small version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/logo_small"
- logo_medium
  string
  URL of the medium version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/logo_medium"
- logo_large
  string
  URL of the large version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/logo_large"
- original
  string
  URL of the original version of the tournament logo.
  Example: "https://www.toornament.com/media/file/123456/original"
registration_enabled
boolean
Whether the registration process is enabled.
Example: true
registration_opening_datetime
string|null
The opening date of the registrations in RFC 3339 format (combined date, time and utc offset)
Format: datetime
Example: "1999-01-01T00:00:00+00:00"
registration_closing_datetime
string|null
The closing date of the registrations in RFC 3339 format (combined date, time and utc offset)
Format: datetime
Example: "1999-01-01T00:00:00+00:00"