Streams

GET /tournaments/{tournament_id}/streams

Authorized Access

Returns the 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 cannot exceed 50. (see Pagination)

    Example: streams=0-49

Path parameters

  • tournament_id
    string

    The id of the tournament for which streams must be retrieved

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

This endpoint doesn't require a request body.

Response

[200] Streams retrieved

Example
{
    "id": "1146390604275957762",
    "name": "Stream",
    "url": "https:\/\/www.twitch.tv\/stream",
    "language": "en"
}
Structure (object)
  • id
    string

    Id of the stream.

    Example: "1146390604275957762"

  • name
    string

    Title of the stream.

    Example: "Stream"

  • url
    string

    Url of the stream.

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

  • language
    string

    Language code of the stream content. This value is represented as an ISO 639-1 code.

    Example: "en"

POST /tournaments/{tournament_id}/streams

Authorized Access

Create a stream for a tournament. You can not exceed 128 streams in total for 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 for which streams must be retrieved

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

Data to provide for create the stream.

Example
{
    "name": "Stream",
    "url": "https:\/\/www.twitch.tv\/stream",
    "language": "en"
}
Structure (object)
  • name
    string

    Title of the stream.

    Example: "Stream"

  • url
    string

    Url of the stream.

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

  • language
    string

    Language code of the stream content. This value is represented as an ISO 639-1 code.

    Example: "en"

Response

[201] Success

Example
{
    "id": "1146390604275957762",
    "name": "Stream",
    "url": "https:\/\/www.twitch.tv\/stream",
    "language": "en"
}
Structure (object)
  • id
    string

    Id of the stream.

    Example: "1146390604275957762"

  • name
    string

    Title of the stream.

    Example: "Stream"

  • url
    string

    Url of the stream.

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

  • language
    string

    Language code of the stream content. This value is represented as an ISO 639-1 code.

    Example: "en"

GET /tournaments/{tournament_id}/streams/{id}

Authorized Access

Returns a single stream by the given id.

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

    An unique identifier of the tournament.

  • id
    string

    The id of the requested stream.

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

This endpoint doesn't require a request body.

Response

[200] Success

Example
{
    "id": "1146390604275957762",
    "name": "Stream",
    "url": "https:\/\/www.twitch.tv\/stream",
    "language": "en"
}
Structure (object)
  • id
    string

    Id of the stream.

    Example: "1146390604275957762"

  • name
    string

    Title of the stream.

    Example: "Stream"

  • url
    string

    Url of the stream.

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

  • language
    string

    Language code of the stream content. This value is represented as an ISO 639-1 code.

    Example: "en"

PATCH /tournaments/{tournament_id}/streams/{id}

Authorized Access

Update a single stream of 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

    An unique identifier of the tournament.

  • id
    string

    The id of the requested stream.

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

Data to provide for update the stream.

Example
{
    "name": "Stream",
    "url": "https:\/\/www.twitch.tv\/stream",
    "language": "en"
}
Structure (object)
  • name
    string

    Title of the stream.

    Example: "Stream"

  • url
    string

    Url of the stream.

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

  • language
    string

    Language code of the stream content. This value is represented as an ISO 639-1 code.

    Example: "en"

Response

[200] Success

Example
{
    "id": "1146390604275957762",
    "name": "Stream",
    "url": "https:\/\/www.twitch.tv\/stream",
    "language": "en"
}
Structure (object)
  • id
    string

    Id of the stream.

    Example: "1146390604275957762"

  • name
    string

    Title of the stream.

    Example: "Stream"

  • url
    string

    Url of the stream.

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

  • language
    string

    Language code of the stream content. This value is represented as an ISO 639-1 code.

    Example: "en"

DELETE /tournaments/{tournament_id}/streams/{id}

Authorized Access

Delete a stream of 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

    An unique identifier of the tournament.

  • id
    string

    The id of the requested stream.

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

This endpoint doesn't require a request body.

Response

[204] Success

GET /tournaments/{tournament_id}/matches/{match_id}/streams

Authorized Access

Returns the streams of the given 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:result scope (see Authorization)

Path parameters

  • tournament_id
    string

    The id of the tournament for which streams must be retrieved

  • match_id
    string

    The id of the match to retrieve

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

This endpoint doesn't require a request body.

Response

[200] Streams retrieved

Example
[
    "618951258745465416",
    "574431425878674446"
]
Structure (object)
  • id
    array[string]

    List of the stream's ids associated to this match.

    Example: ["618951258745465416","574431425878674446"]

PUT /tournaments/{tournament_id}/matches/{match_id}/streams

Authorized Access

Update or create streams about one match. You can not exceed 32 streams in total for 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:result scope (see Authorization)

Path parameters

  • tournament_id
    string

    The id of the match's tournament.

  • match_id
    string

    The id of the requested match.

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

List of stream ids.

Example
[
    "618951258745465416",
    "574431425878674446"
]
Structure (object)
  • id
    array[string]

    A selection of the stream's ids available in this tournament.

    Example: ["618951258745465416","574431425878674446"]

Response

[200] Success

Example
[
    "618951258745465416",
    "574431425878674446"
]
Structure (object)
  • id
    array[string]

    List of the stream's ids associated to this match.

    Example: ["618951258745465416","574431425878674446"]