TwitchApi.Channels.GetChannelInformation (TwitchApi v0.1.3) View Source

⛔ This module is autogenerated please do not modify manually.

Example request from twitch api docs:

descriptions:

This request gets information about the TwitchDev channel.

requests:

curl -X GET 'https://api.twitch.tv/helix/channels?broadcaster_id=141981764'
-H'Authorization: Bearer 2gbdx6oar67tqtcmt49t3wpcgycthx'
-H'Client-Id: wbmytr93xzw8zbg0p1izqyzzc5mbiz'

Example response from twitch api docs:

descriptions:

responses:

{"data":[{"broadcaster_id":"141981764","broadcaster_login":"twitchdev","broadcaster_name":"TwitchDev","broadcaster_language":"en","game_id":"509670","game_name":"Science & Technology","title":"TwitchDev Monthly Update // May 6, 2021","delay":0}]}

Link to this section Summary

Types

The ID of the broadcaster whose channel you want to get. To specify more than one ID, include this parameter for each broadcaster you want to get. For example, broadcaster_id=1234&broadcaster_id=5678. You may specify a maximum of 100 IDs.

Functions

Description:

Gets channel information for users.

Link to this section Types

Specs

broadcaster_id() :: %{broadcaster_id: String.t()}

The ID of the broadcaster whose channel you want to get. To specify more than one ID, include this parameter for each broadcaster you want to get. For example, broadcaster_id=1234&broadcaster_id=5678. You may specify a maximum of 100 IDs.

Link to this section Functions

Specs

call(broadcaster_id()) :: {:ok, Finch.Response.t()} | {:error, Exception.t()}

Description:

Gets channel information for users.

Required authentication:

Valid user token or app access token.

Required authorization: