Tournaments

GET /tournaments

Returns a collection of public tournaments filtered and sorted by the given query parameters. A maximum of 20 tournaments will be returned. Only public tournaments are visible.

Resource URL

https://api.toornament.com/v1/tournaments

Query Parameters

  • discipline
    string

    Returns tournaments using the given discipline.

  • status
    string

    Returns tournaments with the given status. 'setup' implies it has not started yet; 'running' means it has at least one match result; 'completed' indicates all matches have a result.

    Allowed values: setup, running, completed

  • featured
    boolean

    When set to "1", returns featured tournaments in the collection. When set to "0", it returns tournaments without featured. Featured tournaments are tagged by Toornament as major tournaments for a given discipline.

    Allowed values: 0, 1

  • online
    boolean

    When set to "1", returns tournaments that are played online. When set to "0", returns tournaments that are not played online or that have not set this information. Omit this parameter to return tournaments regardless of their online state.

    Allowed values: 0, 1

  • country
    string

    Returns tournaments with the given country. This parameter only accepts ISO 3166-1 alpha-2 country codes. Reminder: this standard is case-sensitive, i.e. a 'uk' value is not valid.

    Example: UK

  • after_start
    date

    Returns tournaments which start at or after the given date. This parameter only uses ISO 8601 dates containing only the date section.

    Example: 2015-06-20

  • before_start
    date

    Returns tournaments which start at or before the given date. This parameter only uses ISO 8601 dates containing only the date section.

    Example: 2015-06-20

  • after_end
    date

    Returns tournaments which end at or after the given date. This parameter only uses ISO 8601 dates containing only the date section.

    Example: 2015-07-25

  • before_end
    date

    Returns tournaments which end at or before the given date. This parameter only uses ISO 8601 dates containing only the date section.

    Example: 2015-07-25

  • sort
    string

    Sorts the collection in a particular order. "date_asc" sorts the tournaments from older to newer; "date_desc" sorts the tournaments from newer to older.

    Allowed values: date_asc, date_desc

    Default: date_desc

  • name
    string

    Returns tournaments with name and full name most relevance.

Request Body

This endpoint doesn't require a request body.

Response

[200] Success

Example
[
    {
        "id": "378426939508809728",
        "discipline": "my_discipline",
        "name": "My Weekly Tournament",
        "full_name": "My Weekly Tournament - Long title",
        "status": "running",
        "date_start": "2015-09-06",
        "date_end": "2015-09-07",
        "online": true,
        "public": true,
        "location": "London",
        "country": "UK",
        "size": 16,
        "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"
        }
    }
]
Structure (collection)
  • id
    string

    An unique identifier for this tournament.

    Example: "378426939508809728"

  • discipline
    string

    This string is a unique identifier of a discipline.

    Example: "my_discipline"

  • name
    string

    Name of a tournament (maximum 30 characeters).

    Example: "My Weekly Tournament"

  • full_name
    string|null

    Complete name of this tournament (maximum 80 characters).

    Example: "My Weekly Tournament - Long title"

  • status
    string

    Status of the tournament. "setup" implies it has not started yet; "running" means it has at least one match result; "completed" indicates all matches have a result.

    Possible values: setup, running, completed

  • date_start
    date|null

    Starting date of the tournament. This value uses the ISO 8601 date containing only the date section.

    Example: "2015-09-06"

  • date_end
    date|null

    Ending date of the tournament. This value uses the ISO 8601 date containing only the date section.

    Example: "2015-09-07"

  • online
    boolean

    Whether the tournament is played on internet or not.

    Example: true

  • public
    boolean

    Whether the tournament is public or private.

    Example: true

  • location
    string|null

    Location (city, address, place of interest) of the tournament.

    Example: "London"

  • country
    string|null

    Country of the tournament. This value uses the ISO 3166-1 alpha-2 country code.

    Example: "UK"

  • size
    integer

    Size of a tournament. Represents the expected number of participants it'll be able to manage.

    Example: 16

  • platforms
    array[string]|null

    Define the list of platforms used for the tournament.

    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
    mixed|null

    The tournament logo on every available formats.

    Example: [https://www.toornament.com/media/file/123456/logo_small,https://www.toornament.com/media/file/123456/logo_medium,https://www.toornament.com/media/file/123456/logo_large,https://www.toornament.com/media/file/123456/original]

POST /tournaments

Authorized Access

Create a new tournament.

Warning! This endpoint can only be used with an Authorized Access.

Resource URL

https://api.toornament.com/v1/tournaments

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

Data to provide in order to create the tournament.

Example
{
    "discipline": "my_discipline",
    "name": "My Weekly Tournament",
    "size": 16,
    "participant_type": "team",
    "full_name": "My Weekly Tournament - Long title",
    "organization": "Avery Bullock",
    "website": "http:\/\/www.toornament.com",
    "date_start": "2015-09-06",
    "date_end": "2015-09-07",
    "timezone": "America\/Sao_Paulo",
    "online": true,
    "public": true,
    "location": "London",
    "country": "UK",
    "description": "My description \n on multiple lines",
    "rules": "My rules \n on multiple lines",
    "prize": "1 - 10,000$ \n 2 - 5,000$",
    "check_in": true,
    "participant_nationality": true,
    "match_format": "bo3",
    "platforms": [
        "pc",
        "playstation4"
    ]
}
Structure (object)
  • discipline
    string

    This string is a unique identifier of a discipline.

    Example: "my_discipline"

  • name
    string

    Name of a tournament (maximum 30 characeters).

    Example: "My Weekly Tournament"

  • size
    integer

    Size of a tournament. Represents the expected number of participants it'll be able to manage.

    Example: 16

  • participant_type
    string

    Type of participants who plays in the tournament.

    Possible values: team, single

  • full_name
    string|null

    Optional

    Complete name of this tournament (maximum 80 characters).

    Example: "My Weekly Tournament - Long title"

  • organization
    string|null

    Optional

    Tournament organizer: individual, group, association or company.

    Example: "Avery Bullock"

  • website
    string|null

    Optional

    URL of the website

    Example: "http://www.toornament.com"

  • date_start
    date|null

    Optional

    Starting date of the tournament. This value uses the ISO 8601 date containing only the date section.

    Example: "2015-09-06"

  • date_end
    date|null

    Optional

    Ending date of the tournament. This value uses the ISO 8601 date containing only the date section.

    Example: "2015-09-07"

  • timezone
    string|null

    Optional

    Time zone of the tournament. This value is represented using the IANA tz database.

    Example: "America/Sao_Paulo"

  • online
    boolean

    Optional

    Whether the tournament is played on internet or not.

    Example: true

  • public
    boolean

    Optional

    Whether the tournament is public or private. To make public a tournament, the tournament must have a start date, the date_start field.

    Example: true

  • location
    string|null

    Optional

    Location (city, address, place of interest) of the tournament.

    Example: "London"

  • country
    string|null

    Optional

    Country of the tournament. This value uses the ISO 3166-1 alpha-2 country code.

    Example: "UK"

  • description
    string|null

    Optional

    User-defined description of the tournament (maximum 1,500 characters).

    Example: "My description \n on multiple lines"

  • rules
    string|null

    Optional

    User-defined rules of the tournament (maximum 10,000 characters).

    Example: "My rules \n on multiple lines"

  • prize
    string|null

    Optional

    User-defined description of the tournament prizes (maximum 1,500 characters).

    Example: "1 - 10,000$ \n 2 - 5,000$"

  • check_in
    boolean

    Optional

    Enable or disable the participant check-in in the tournament.

    Example: true

  • participant_nationality
    boolean

    Optional

    Enable or disable the participant flag in the tournament.

    Example: true

  • match_format
    string|null

    Optional

    Define the default match format for every matches in the tournament.

    Possible values: none, one, home_away, bo3, bo5, bo7, bo9, bo11

  • platforms
    array[string]|null

    Optional

    Define the list of platforms used for the tournament.

    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

Response

[201] Success

Example
{
    "id": "378426939508809728",
    "discipline": "my_discipline",
    "name": "My Weekly Tournament",
    "full_name": "My Weekly Tournament - Long title",
    "status": "running",
    "date_start": "2015-09-06",
    "date_end": "2015-09-07",
    "timezone": "America\/Sao_Paulo",
    "online": true,
    "public": true,
    "location": "London",
    "country": "UK",
    "size": 16,
    "participant_type": "team",
    "match_type": "duel",
    "organization": "Avery Bullock",
    "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$",
    "check_in": true,
    "participant_nationality": true,
    "match_format": "bo3",
    "platforms": [
        "pc",
        "playstation4"
    ]
}
Structure (object)
  • id
    string

    An unique identifier for this tournament.

    Example: "378426939508809728"

  • discipline
    string

    This string is a unique identifier of a discipline.

    Example: "my_discipline"

  • name
    string

    Name of a tournament (maximum 30 characeters).

    Example: "My Weekly Tournament"

  • full_name
    string|null

    Complete name of this tournament (maximum 80 characters).

    Example: "My Weekly Tournament - Long title"

  • status
    string

    Status of the tournament. "setup" implies it has not started yet; "running" means it has at least one match result; "completed" indicates all matches have a result.

    Possible values: setup, running, completed

  • date_start
    date|null

    Starting date of the tournament. This value uses the ISO 8601 date containing only the date section.

    Example: "2015-09-06"

  • date_end
    date|null

    Ending date of the tournament. This value uses the ISO 8601 date containing only the date section.

    Example: "2015-09-07"

  • timezone
    string|null

    Time zone of the tournament. This value is represented using the IANA tz database.

    Example: "America/Sao_Paulo"

  • online
    boolean

    Whether the tournament is played on internet or not.

    Example: true

  • public
    boolean

    Whether the tournament is public or private.

    Example: true

  • location
    string|null

    Location (city, address, place of interest) of the tournament.

    Example: "London"

  • country
    string|null

    Country of the tournament. This value uses the ISO 3166-1 alpha-2 country code.

    Example: "UK"

  • size
    integer

    Size of a tournament. Represents the expected number of participants it'll be able to manage.

    Example: 16

  • participant_type
    string

    Type of participants who plays in the tournament.

    Possible values: team, single

  • match_type
    string

    Type of matches played in the tournament.

    Possible values: duel, ffa

  • organization
    string|null

    Tournament organizer: individual, group, association or company.

    Example: "Avery Bullock"

  • website
    string|null

    URL of the website

    Example: "http://www.toornament.com"

  • description
    string|null

    User-defined description of the tournament (maximum 1,500 characters).

    Example: "My description \n on multiple lines"

  • rules
    string|null

    User-defined rules of the tournament (maximum 10,000 characters).

    Example: "My rules \n on multiple lines"

  • prize
    string|null

    User-defined description of the tournament prizes (maximum 1,500 characters).

    Example: "1 - 10,000$ \n 2 - 5,000$"

  • team_size_min
    integer

    Optional

    If the "participant type" value in this tournament is 'team', specify the smallest possible team size.

  • team_size_max
    integer

    Optional

    If the "participant type" value in this tournament is 'team', specify the largest possible team size.

  • check_in
    boolean

    Enable or disable the participant check-in in the tournament.

    Example: true

  • participant_nationality
    boolean

    Enable or disable the participant flag in the tournament.

    Example: true

  • match_format
    string|null

    Define the default match format for every matches in the tournament.

    Possible values: none, one, home_away, bo3, bo5, bo7, bo9, bo11

  • platforms
    array[string]|null

    Define the list of platforms used for the tournament.

    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

GET /tournaments/{id}

Returns detailed information about one tournament. The tournament must be public.

Resource URL

https://api.toornament.com/v1/tournaments/{id}

Path parameters

  • id
    string

    An unique identifier of the tournament to retrieve.

Query Parameters

  • with_streams
    boolean

    When set to '1', it will include streams of the tournament.
    Warning: The default value will soon change from "1" to "0". Please check that your request query value is set to "1" to avoid errors.

    Allowed values: 1, 0

    Default: 1

Request Body

This endpoint doesn't require a request body.

Response

[200] Success

Example
{
    "id": "378426939508809728",
    "discipline": "my_discipline",
    "name": "My Weekly Tournament",
    "full_name": "My Weekly Tournament - Long title",
    "status": "running",
    "date_start": "2015-09-06",
    "date_end": "2015-09-07",
    "timezone": "America\/Sao_Paulo",
    "online": true,
    "public": true,
    "location": "London",
    "country": "UK",
    "size": 16,
    "participant_type": "team",
    "match_type": "duel",
    "organization": "Avery Bullock",
    "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$",
    "streams": [
        {
            "id": "378426939508809728",
            "name": "DreamhackCS",
            "url": "http:\/\/www.twitch.tv\/dreamhackcs",
            "language": "en"
        }
    ],
    "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"
    },
    "check_in": true,
    "participant_nationality": true,
    "match_format": "bo3"
}
Structure (object)
  • id
    string

    An unique identifier for this tournament.

    Example: "378426939508809728"

  • discipline
    string

    This string is a unique identifier of a discipline.

    Example: "my_discipline"

  • name
    string

    Name of a tournament (maximum 30 characeters).

    Example: "My Weekly Tournament"

  • full_name
    string|null

    Complete name of this tournament (maximum 80 characters).

    Example: "My Weekly Tournament - Long title"

  • status
    string

    Status of the tournament. "setup" implies it has not started yet; "running" means it has at least one match result; "completed" indicates all matches have a result.

    Possible values: setup, running, completed

  • date_start
    date|null

    Starting date of the tournament. This value uses the ISO 8601 date containing only the date section.

    Example: "2015-09-06"

  • date_end
    date|null

    Ending date of the tournament. This value uses the ISO 8601 date containing only the date section.

    Example: "2015-09-07"

  • timezone
    string|null

    Time zone of the tournament. This value is represented using the IANA tz database.

    Example: "America/Sao_Paulo"

  • online
    boolean

    Whether the tournament is played on internet or not.

    Example: true

  • public
    boolean

    Whether the tournament is public or private.

    Example: true

  • location
    string|null

    Location (city, address, place of interest) of the tournament.

    Example: "London"

  • country
    string|null

    Country of the tournament. This value uses the ISO 3166-1 alpha-2 country code.

    Example: "UK"

  • size
    integer

    Size of a tournament. Represents the expected number of participants it'll be able to manage.

    Example: 16

  • participant_type
    string

    Type of participants who plays in the tournament.

    Possible values: team, single

  • match_type
    string

    Type of matches played in the tournament.

    Possible values: duel, ffa

  • organization
    string|null

    Tournament organizer: individual, group, association or company.

    Example: "Avery Bullock"

  • website
    string|null

    URL of the website

    Example: "http://www.toornament.com"

  • description
    string|null

    User-defined description of the tournament (maximum 1,500 characters).

    Example: "My description \n on multiple lines"

  • rules
    string|null

    User-defined rules of the tournament (maximum 10,000 characters).

    Example: "My rules \n on multiple lines"

  • prize
    string|null

    User-defined description of the tournament prizes (maximum 1,500 characters).

    Example: "1 - 10,000$ \n 2 - 5,000$"

  • team_size_min
    integer

    Optional

    If the "participant type" value in this tournament is 'team', specify the smallest possible team size.

  • team_size_max
    integer

    Optional

    If the "participant type" value in this tournament is 'team', specify the largest possible team size.

  • streams
    array[object]

    Optional

  • platforms
    array[string]|null

    Define the list of platforms used for the tournament.

    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
    mixed|null

    The tournament logo on every available formats.

    Example: [https://www.toornament.com/media/file/123456/logo_small,https://www.toornament.com/media/file/123456/logo_medium,https://www.toornament.com/media/file/123456/logo_large,https://www.toornament.com/media/file/123456/original]

  • check_in
    boolean

    PrivateOptional

    Enable or disable the participant check-in in the tournament.

    Example: true

  • participant_nationality
    boolean

    PrivateOptional

    Enable or disable the participant flag in the tournament.

    Example: true

  • match_format
    string|null

    PrivateOptional

    Define the default match format for every matches in the tournament.

    Possible values: none, one, home_away, bo3, bo5, bo7, bo9, bo11

PATCH /tournaments/{id}

Authorized Access

Update some of the editable information on a tournament.

Warning! This endpoint can only be used with an Authorized Access.

Resource URL

https://api.toornament.com/v1/tournaments/{id}

Path parameters

  • id
    string

    An unique identifier of the tournament to retrieve.

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

Success

Example
{
    "name": "My Weekly Tournament",
    "size": 16,
    "full_name": "My Weekly Tournament - Long title",
    "organization": "Avery Bullock",
    "website": "http:\/\/www.toornament.com",
    "date_start": "2015-09-06",
    "date_end": "2015-09-07",
    "timezone": "America\/Sao_Paulo",
    "online": true,
    "public": true,
    "location": "London",
    "country": "UK",
    "description": "My description \n on multiple lines",
    "rules": "My rules \n on multiple lines",
    "prize": "1 - 10,000$ \n 2 - 5,000$",
    "check_in": true,
    "participant_nationality": true,
    "match_format": "bo3",
    "platforms": [
        "pc",
        "playstation4"
    ]
}
Structure (object)
  • name
    string

    Name of a tournament (maximum 30 characeters).

    Example: "My Weekly Tournament"

  • size
    integer

    Size of a tournament. Represents the expected number of participants it'll be able to manage.

    Example: 16

  • full_name
    string|null

    Complete name of this tournament (maximum 80 characters).

    Example: "My Weekly Tournament - Long title"

  • organization
    string|null

    Tournament organizer: individual, group, association or company.

    Example: "Avery Bullock"

  • website
    string|null

    URL of the website

    Example: "http://www.toornament.com"

  • date_start
    date|null

    Starting date of the tournament. This value uses the ISO 8601 date containing only the date section.

    Example: "2015-09-06"

  • date_end
    date|null

    Ending date of the tournament. This value uses the ISO 8601 date containing only the date section.

    Example: "2015-09-07"

  • timezone
    string|null

    Time zone of the tournament. This value is represented using the IANA tz database.

    Example: "America/Sao_Paulo"

  • online
    boolean

    Whether the tournament is played on internet or not.

    Example: true

  • public
    boolean

    Whether the tournament is public or private. To make public a tournament, the tournament must have a start date, the date_start field.

    Example: true

  • location
    string|null

    Location (city, address, place of interest) of the tournament.

    Example: "London"

  • country
    string|null

    Country of the tournament. This value uses the ISO 3166-1 alpha-2 country code.

    Example: "UK"

  • description
    string|null

    User-defined description of the tournament (maximum 1,500 characters).

    Example: "My description \n on multiple lines"

  • rules
    string|null

    User-defined rules of the tournament (maximum 10,000 characters).

    Example: "My rules \n on multiple lines"

  • prize
    string|null

    User-defined description of the tournament prizes (maximum 1,500 characters).

    Example: "1 - 10,000$ \n 2 - 5,000$"

  • check_in
    boolean

    Enable or disable the participant check-in in the tournament.

    Example: true

  • participant_nationality
    boolean

    Enable or disable the participant flag in the tournament.

    Example: true

  • match_format
    string|null

    Define the default match format for every matches in the tournament.

    Possible values: none, one, home_away, bo3, bo5, bo7, bo9, bo11

  • platforms
    array[string]|null

    Define the list of platforms used for the tournament.

    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

Response

[200] Success

Example
{
    "id": "378426939508809728",
    "discipline": "my_discipline",
    "name": "My Weekly Tournament",
    "full_name": "My Weekly Tournament - Long title",
    "status": "running",
    "date_start": "2015-09-06",
    "date_end": "2015-09-07",
    "timezone": "America\/Sao_Paulo",
    "online": true,
    "public": true,
    "location": "London",
    "country": "UK",
    "size": 16,
    "participant_type": "team",
    "match_type": "duel",
    "organization": "Avery Bullock",
    "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$",
    "check_in": true,
    "participant_nationality": true,
    "match_format": "bo3",
    "platforms": [
        "pc",
        "playstation4"
    ]
}
Structure (object)
  • id
    string

    An unique identifier for this tournament.

    Example: "378426939508809728"

  • discipline
    string

    This string is a unique identifier of a discipline.

    Example: "my_discipline"

  • name
    string

    Name of a tournament (maximum 30 characeters).

    Example: "My Weekly Tournament"

  • full_name
    string|null

    Complete name of this tournament (maximum 80 characters).

    Example: "My Weekly Tournament - Long title"

  • status
    string

    Status of the tournament. "setup" implies it has not started yet; "running" means it has at least one match result; "completed" indicates all matches have a result.

    Possible values: setup, running, completed

  • date_start
    date|null

    Starting date of the tournament. This value uses the ISO 8601 date containing only the date section.

    Example: "2015-09-06"

  • date_end
    date|null

    Ending date of the tournament. This value uses the ISO 8601 date containing only the date section.

    Example: "2015-09-07"

  • timezone
    string|null

    Time zone of the tournament. This value is represented using the IANA tz database.

    Example: "America/Sao_Paulo"

  • online
    boolean

    Whether the tournament is played on internet or not.

    Example: true

  • public
    boolean

    Whether the tournament is public or private.

    Example: true

  • location
    string|null

    Location (city, address, place of interest) of the tournament.

    Example: "London"

  • country
    string|null

    Country of the tournament. This value uses the ISO 3166-1 alpha-2 country code.

    Example: "UK"

  • size
    integer

    Size of a tournament. Represents the expected number of participants it'll be able to manage.

    Example: 16

  • participant_type
    string

    Type of participants who plays in the tournament.

    Possible values: team, single

  • match_type
    string

    Type of matches played in the tournament.

    Possible values: duel, ffa

  • organization
    string|null

    Tournament organizer: individual, group, association or company.

    Example: "Avery Bullock"

  • website
    string|null

    URL of the website

    Example: "http://www.toornament.com"

  • description
    string|null

    User-defined description of the tournament (maximum 1,500 characters).

    Example: "My description \n on multiple lines"

  • rules
    string|null

    User-defined rules of the tournament (maximum 10,000 characters).

    Example: "My rules \n on multiple lines"

  • prize
    string|null

    User-defined description of the tournament prizes (maximum 1,500 characters).

    Example: "1 - 10,000$ \n 2 - 5,000$"

  • team_size_min
    integer

    Optional

    If the "participant type" value in this tournament is 'team', specify the smallest possible team size.

  • team_size_max
    integer

    Optional

    If the "participant type" value in this tournament is 'team', specify the largest possible team size.

  • check_in
    boolean

    Enable or disable the participant check-in in the tournament.

    Example: true

  • participant_nationality
    boolean

    Enable or disable the participant flag in the tournament.

    Example: true

  • match_format
    string|null

    Define the default match format for every matches in the tournament.

    Possible values: none, one, home_away, bo3, bo5, bo7, bo9, bo11

  • platforms
    array[string]|null

    Define the list of platforms used for the tournament.

    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

DELETE /tournaments/{id}

Authorized Access

Delete a tournament, its participants and all its matches.

Warning! This endpoint can only be used with an Authorized Access.

Resource URL

https://api.toornament.com/v1/tournaments/{id}

Path parameters

  • id
    string

    An unique identifier of the tournament to retrieve.

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

This endpoint doesn't require a request body.

Response

[204] Success

GET /me/tournaments

Authorized Access

Returns the private and public tournaments on which the authenticated user has access. The result is filtered, sorted and paginated by the given query parameters. A maximum of 50 tournaments is returned (per page).

Warning! This endpoint can only be used with an Authorized Access.

Resource URL

https://api.toornament.com/v1/me/tournaments

Query Parameters

  • name
    string

    Returns tournaments with name and full name most relevance.

  • discipline
    string

    Returns tournaments using the given discipline.

  • status
    string

    Returns tournaments with the given status. 'setup' implies it has not started yet; 'running' means it has at least one match result; 'completed' indicates all matches have a result.

    Allowed values: setup, running, completed

  • archived
    boolean

    Whether the tournament is archived or not.

    Allowed values: 0, 1

    Example: 0

  • online
    boolean

    When set to "1", returns tournaments that are played online. When set to "0", returns tournaments that are not played online or that have not set this information. Omit this parameter to return tournaments regardless of their online state.

    Allowed values: 0, 1

  • country
    string

    Returns tournaments with the given country. This parameter only accepts ISO 3166-1 alpha-2 country codes. Reminder: this standard is case-sensitive, i.e. a 'uk' value is not valid.

    Example: UK

  • after_start
    date

    Returns tournaments which start at or after the given date. This parameter only uses ISO 8601 dates containing only the date section.

    Example: 2015-06-20

  • before_start
    date

    Returns tournaments which start at or before the given date. This parameter only uses ISO 8601 dates containing only the date section.

    Example: 2015-06-20

  • after_end
    date

    Returns tournaments which end at or after the given date. This parameter only uses ISO 8601 dates containing only the date section.

    Example: 2015-07-25

  • before_end
    date

    Returns tournaments which end at or before the given date. This parameter only uses ISO 8601 dates containing only the date section.

    Example: 2015-07-25

  • sort
    string

    Sorts the collection in a particular order. "date_asc" sorts the tournaments from older to newer; "date_desc" sorts the tournaments from newer to older.

    Allowed values: date_asc, date_desc

    Default: date_desc

  • page
    integer

    Returns the tournaments of the given page number.

    Default: 1

Request Body

This endpoint doesn't require a request body.

Response

[200] Success

Example
[
    {
        "id": "378426939508809728",
        "discipline": "my_discipline",
        "name": "My Weekly Tournament",
        "full_name": "My Weekly Tournament - Long title",
        "status": "running",
        "date_start": "2015-09-06",
        "date_end": "2015-09-07",
        "online": true,
        "public": true,
        "archived": false,
        "location": "London",
        "country": "UK",
        "size": 16,
        "platforms": [
            "pc",
            "playstation4"
        ]
    }
]
Structure (collection)
  • id
    string

    An unique identifier for this tournament.

    Example: "378426939508809728"

  • discipline
    string

    This string is a unique identifier of a discipline.

    Example: "my_discipline"

  • name
    string

    Name of a tournament (maximum 30 characeters).

    Example: "My Weekly Tournament"

  • full_name
    string|null

    Complete name of this tournament (maximum 80 characters).

    Example: "My Weekly Tournament - Long title"

  • status
    string

    Status of the tournament. "setup" implies it has not started yet; "running" means it has at least one match result; "completed" indicates all matches have a result.

    Possible values: setup, running, completed

  • date_start
    date|null

    Starting date of the tournament. This value uses the ISO 8601 date containing only the date section.

    Example: "2015-09-06"

  • date_end
    date|null

    Ending date of the tournament. This value uses the ISO 8601 date containing only the date section.

    Example: "2015-09-07"

  • online
    boolean

    Whether the tournament is played on internet or not.

    Example: true

  • public
    boolean

    Whether the tournament is public or private.

    Example: true

  • archived
    boolean

    If this tournament is archived.

    Example: false

  • location
    string|null

    Location (city, address, place of interest) of the tournament.

    Example: "London"

  • country
    string|null

    Country of the tournament. This value uses the ISO 3166-1 alpha-2 country code.

    Example: "UK"

  • size
    integer

    Size of a tournament. Represents the expected number of participants it'll be able to manage.

    Example: 16

  • platforms
    array[string]|null

    Define the list of platforms used for the tournament.

    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