Streams

Returns the list of streams of the given tournament.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/streams

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:admin scope (see Authorization)

• Range

  string

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

  Example: streams=0-49

Path parameters

• tournament_id

  string

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

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[206] Streams retrieved.

Example

[
    {
        "name": "Stream",
        "url": "https:\/\/www.twitch.tv\/stream",
        "language": "en",
        "id": "1146390604275957762"
    }
]

Structure (collection)

• name

  string

  The title of the stream.

  Example: "Stream"

• url

  string

  The URL of the stream.

  Example: "https://www.twitch.tv/stream"

• language

  string

  Language of the stream content, in ISO 639-1 alpha-2 format.

  Example: "en"

• id

  string

  The id of the stream.

  Example: "1146390604275957762"

Create a new stream in a tournament. You can not have more than 128 streams in a tournament.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/streams

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:admin scope (see Authorization)

Path parameters

• tournament_id

  string

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

Query Parameters

This endpoint does not have any query parameters.

Request Body

Stream data

Example

{
    "name": "Stream",
    "url": "https:\/\/www.twitch.tv\/stream",
    "language": "en"
}

Structure (object)

• name

  string

  Optional

  The title of the stream.

  Example: "Stream"

• url

  string

  Optional

  The URL of the stream.

  Example: "https://www.twitch.tv/stream"

• language

  string

  Optional

  Language of the stream content, in ISO 639-1 alpha-2 format.

  Example: "en"

Response

[201] Success

Example

{
    "name": "Stream",
    "url": "https:\/\/www.twitch.tv\/stream",
    "language": "en",
    "id": "1146390604275957762"
}

Structure (object)

• name

  string

  The title of the stream.

  Example: "Stream"

• url

  string

  The URL of the stream.

  Example: "https://www.twitch.tv/stream"

• language

  string

  Language of the stream content, in ISO 639-1 alpha-2 format.

  Example: "en"

• id

  string

  The id of the stream.

  Example: "1146390604275957762"

Returns a single stream from a tournament.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/streams/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:admin scope (see Authorization)

Path parameters

• tournament_id

  string

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

• id

  string

  The id of the stream.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Success

Example

{
    "name": "Stream",
    "url": "https:\/\/www.twitch.tv\/stream",
    "language": "en",
    "id": "1146390604275957762"
}

Structure (object)

• name

  string

  The title of the stream.

  Example: "Stream"

• url

  string

  The URL of the stream.

  Example: "https://www.twitch.tv/stream"

• language

  string

  Language of the stream content, in ISO 639-1 alpha-2 format.

  Example: "en"

• id

  string

  The id of the stream.

  Example: "1146390604275957762"

Update a single stream in a tournament.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/streams/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:admin scope (see Authorization)

Path parameters

• tournament_id

  string

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

• id

  string

  The id of the stream.

Query Parameters

This endpoint does not have any query parameters.

Request Body

Stream data

Example

{
    "name": "Stream",
    "url": "https:\/\/www.twitch.tv\/stream",
    "language": "en"
}

Structure (object)

• name

  string

  Optional

  The title of the stream.

  Example: "Stream"

• url

  string

  Optional

  The URL of the stream.

  Example: "https://www.twitch.tv/stream"

• language

  string

  Optional

  Language of the stream content, in ISO 639-1 alpha-2 format.

  Example: "en"

Response

[200] Success

Example

{
    "name": "Stream",
    "url": "https:\/\/www.twitch.tv\/stream",
    "language": "en",
    "id": "1146390604275957762"
}

Structure (object)

• name

  string

  The title of the stream.

  Example: "Stream"

• url

  string

  The URL of the stream.

  Example: "https://www.twitch.tv/stream"

• language

  string

  Language of the stream content, in ISO 639-1 alpha-2 format.

  Example: "en"

• id

  string

  The id of the stream.

  Example: "1146390604275957762"

Delete a stream in a tournament.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/streams/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:admin scope (see Authorization)

Path parameters

• tournament_id

  string

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

• id

  string

  The id of the stream.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[204] Success

Returns the list of streams linked to a match. 32 streams maximum linked to a match.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/matches/{match_id}/streams

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:admin scope (see Authorization)

Path parameters

• tournament_id

  string

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

• match_id

  string

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

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Success

Example

[
    "618951258745465416",
    "574431425878674446"
]

Structure (object)

• id

  array[string]

  The list of stream ids associated to this match.

  Example: ["618951258745465416","574431425878674446"]

Update the list of streams linked to a match. You can not have more than 32 streams in linked to a match.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/matches/{match_id}/streams

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:admin scope (see Authorization)

Path parameters

• tournament_id

  string

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

• match_id

  string

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

Query Parameters

This endpoint does not have any query parameters.

Request Body

Stream data

Example

[
    "618951258745465416",
    "574431425878674446"
]

Structure (object)

• id

  array[string]

  The list of stream ids associated to this match.

  Example: ["618951258745465416","574431425878674446"]

Response

[200] Success

Example

[
    "618951258745465416",
    "574431425878674446"
]

Structure (object)

• id

  array[string]

  The list of stream ids associated to this match.

  Example: ["618951258745465416","574431425878674446"]