TwitchChannelsRequests
Inherits: TwitchRequestBase < RefCounted < Object
Twitch Channels API for channel information, editors, and followers.
Description
TwitchChannelsRequests provides methods for getting and modifying channel information, managing editors, and accessing follower data. Requires various OAuth scopes depending on the operation. Access through TwitchAPI.get_channels().
Tutorials
Methods
void |
get_channel_editors(broadcaster_id: String) |
void |
get_channel_followers(broadcaster_id: String, params: Dictionary = {}) |
void |
get_channel_information(broadcaster_id: String) |
void |
get_followed_channels(user_id: String, params: Dictionary = {}) |
void |
modify_channel_information(broadcaster_id: String, data: Dictionary) |
Method Descriptions
void get_channel_editors(broadcaster_id: String) 🔗
Gets the list of users who are editors for the broadcaster's channel. Requires channel:read:editors scope. Results are returned via the TwitchAPI.request_completed signal with signal_name "channel_editors_received".
Response includes: Array of editors with user_id, user_name, created_at.
TwitchAPI.get_channels().get_channel_editors("broadcaster_id")
# Response: {"data": [{"user_id": "123", "user_name": "EditorUser", "created_at": "2025-01-15T10:00:00Z"}]}
void get_channel_followers(broadcaster_id: String, params: Dictionary = {}) 🔗
Gets a list of users that follow the broadcaster. Optional params can include user_id and first. Requires moderator:read:followers scope. Results are returned via the TwitchAPI.request_completed signal with signal_name "channel_followers_received".
Response includes: Array of followers with user_id, user_login, user_name, followed_at; total follower count.
TwitchAPI.get_channels().get_channel_followers("broadcaster_id", {"first": 20})
# Response: {"data": [{"user_id": "456", "user_login": "follower1", "user_name": "Follower1", "followed_at": "2025-10-01T12:00:00Z"}], "total": 5000}
void get_channel_information(broadcaster_id: String) 🔗
Gets information about a channel including title, game, language, and tags. Results are returned via the TwitchAPI.request_completed signal with signal_name "channel_information_received".
Response includes: broadcaster_id/login/name, game_id, game_name, broadcaster_language, title, delay, tags, content_classification_labels, is_branded_content.
TwitchAPI.get_channels().get_channel_information("broadcaster_id")
# Response: {"data": [{"broadcaster_id": "123", "broadcaster_name": "MyChannel", "game_id": "509658", "game_name": "Just Chatting", "title": "Streaming today!", "tags": ["English"]}]}
void get_followed_channels(user_id: String, params: Dictionary = {}) 🔗
Gets a list of channels that the specified user follows. Optional params can include broadcaster_id and first. Requires user:read:follows scope. Results are returned via the TwitchAPI.request_completed signal with signal_name "followed_channels_received".
Response includes: Array of channels with broadcaster_id, broadcaster_login, broadcaster_name, followed_at; total channels followed.
TwitchAPI.get_channels().get_followed_channels("user_id", {"first": 10})
# Response: {"data": [{"broadcaster_id": "789", "broadcaster_login": "channel1", "broadcaster_name": "Channel1", "followed_at": "2025-09-01T10:00:00Z"}], "total": 42}
void modify_channel_information(broadcaster_id: String, data: Dictionary) 🔗
Modifies channel information such as title, game_id, broadcaster_language, delay, and tags. Requires channel:manage:broadcast scope. Results are returned via the TwitchAPI.request_completed signal with signal_name "channel_information_modified".
Response: Returns 204 No Content on success.
var updates = {"title": "New Stream Title!", "game_id": "509658"}
TwitchAPI.get_channels().modify_channel_information("broadcaster_id", updates)
# Response: 204 No Content on success