twitch.channels

Every method of twitch.channels, with its parameters, what it returns and the token it needs.

get

twitch.channels.get(params, options?): Promise<ChannelInformation[]>

Gets the title, category, language and tags of one or more channels. Channels that do not exist are left out of the result.

Token: app or user.

Parameters

Name	Type	Description
broadcaster_id required	string | readonly string[]	IDs of the broadcasters to get. Any number: long lists are split for you.

options: Request options for this call: as, token, signal, timeout, retries.

Returns

Promise<ChannelInformation[]>

Fields of ChannelInformation

Name	Type	Description
broadcaster_id	string	ID of the broadcaster.
broadcaster_login	string	Login name of the broadcaster.
broadcaster_name	string	Display name of the broadcaster.
broadcaster_language	string	Language of the channel: an ISO 639-1 code, or "other".
game_name	string	Name of the current or last category. An empty string when the channel never had one.
game_id	string	ID of the current or last category. An empty string when the channel never had one.
title	string	Title of the current or last stream. An empty string when the channel never streamed.
delay	number	Stream delay in seconds. Stays at 0 unless the call is made with the token of this broadcaster, who must be a partner with a delay set.
tags	string[]	Tags applied to the channel.
content_classification_labels	string[]	IDs of the content classification labels applied to the channel.
is_branded_content	boolean	Whether the channel is flagged as showing branded content.

Example

const [channel] = await twitch.channels.get({ broadcaster_id: "141981764" });
console.log(channel?.title, channel?.game_name);

Twitch reference

update

twitch.channels.update(params?, options?): Promise<void>

Changes the title, category, language, tags, delay or content labels of a channel. Only the fields you set are touched.

Token: user, scope channel:manage:broadcast.

Parameters

Name	Type	Description
broadcaster_id	string	Broadcaster whose channel to update. Defaults to the user making the call.
game_id	string	ID of the category to set. "0" or an empty string clears it.
broadcaster_language	string	Language of the channel: an ISO 639-1 code, or "other".
title	string	Stream title, 140 characters at most. Cannot be empty.
delay	number	Stream delay in seconds, 900 at most. Partners only.
tags	readonly string[]	Tags to apply, replacing the current ones. Up to 10, each 25 characters at most, without spaces or special characters. An empty array removes them all.
content_classification_labels	readonly ChannelContentLabel[]	Labels to switch on or off. Labels you leave out keep their current state.
is_branded_content	boolean	Whether the channel shows branded content.

options: Request options for this call: as, token, signal, timeout, retries.

Returns

Promise<void>

Example

await twitch.channels.update({ title: "Speedrun practice", game_id: "33214", tags: ["Speedrun"] });

Twitch reference

editors

twitch.channels.editors(params?, options?): Promise<ChannelEditor[]>

Lists the editors of a channel.

Token: user, scope channel:read:editors.

Parameters

Name	Type	Description
broadcaster_id	string	Broadcaster who owns the channel. Defaults to the user making the call.

options: Request options for this call: as, token, signal, timeout, retries.

Returns

Promise<ChannelEditor[]>

Fields of ChannelEditor

Name	Type	Description
user_id	string	ID of the editor.
user_name	string	Display name of the editor.
created_at	string	When the user was made an editor, as an RFC 3339 timestamp.

Example

const editors = await twitch.channels.editors();

Twitch reference

followed

twitch.channels.followed(params?, options?): Paginator<FollowedChannel>

Lists the channels a user follows, most recent follow first. With broadcaster_id it tells whether the user follows that one channel.

Token: user, scope user:read:follows.

Parameters

Name	Type	Description
user_id	string	User whose follows to list. Defaults to the user making the call.
broadcaster_id	string	Only this broadcaster: the list holds one item when the user follows them, none otherwise.
first	number	Items per page, 1 to 100. Twitch defaults to 20.
after	string	Cursor of the next page.

options: Request options for this call: as, token, signal, timeout, retries.

Returns

Paginator<FollowedChannel>

Fields of FollowedChannel

Name	Type	Description
broadcaster_id	string	ID of the followed broadcaster.
broadcaster_login	string	Login name of the followed broadcaster.
broadcaster_name	string	Display name of the followed broadcaster.
followed_at	string	When the user started following, as an RFC 3339 timestamp.

Example

for await (const follow of twitch.channels.followed()) console.log(follow.broadcaster_name);
const count = await twitch.channels.followed().total();
const follows = (await twitch.channels.followed({ broadcaster_id: "141981764" })).data.length > 0;

Twitch reference

followers

twitch.channels.followers(params, options?): Paginator<ChannelFollower>

Lists the followers of a channel, most recent first. The list itself is only returned to the broadcaster or one of their moderators, with the moderator:read:followers scope. Any other token gets an empty list but still gets the follower count, which is what total() reads. With user_id it tells whether that one user follows the channel.

Token: app or user. Scope moderator:read:followers to get the list.

Parameters

Name	Type	Description
broadcaster_id required	string	Broadcaster whose followers to list.
user_id	string	Only this user: the list holds one item when they follow the broadcaster, none otherwise.
first	number	Items per page, 1 to 100. Twitch defaults to 20.
after	string	Cursor of the next page.

options: Request options for this call: as, token, signal, timeout, retries.

Returns

Paginator<ChannelFollower>

Fields of ChannelFollower

Name	Type	Description
user_id	string	ID of the follower.
user_login	string	Login name of the follower.
user_name	string	Display name of the follower.
followed_at	string	When the user started following, as an RFC 3339 timestamp.

Example

const latest = await twitch.channels.followers({ broadcaster_id: "141981764" }).take(10);
const count = await twitch.channels.followers({ broadcaster_id: "141981764" }).total();

Twitch reference