Documentation
- class twitchio.AutomodMessageHold¶
Represents an automod message hold event. Both V1 and V2.
- broadcaster¶
The broadcaster specified in the request.
- Type
- user¶
The user who sent the message.
- Type
- level¶
The level of severity. Measured between 1 to 4. This is None if the V2 endpoint is used and the reason is blocked_term.
- Type
int | None
- category¶
The category of the message. This is None if the V2 endpoint is used and the reason is blocked_term.
- Type
str | None
- held_at¶
The datetime of when automod saved the message.
- Type
- fragments¶
List of chat message fragments.
- Type
- reason¶
The reason for the message being held. This is only populated for the V2 endpoint.
- Type
Literal[“automod”, “blocked_term”] | None
- boundaries¶
The start and end index of the words caught by automod. This is only populated for the V2 endpoint and when the reason is automod.
- property emotes: list[twitchio.models.eventsub_.ChatMessageEmote]¶
A property that lists all of the emotes of a message. If no emotes are in the message this will return an empty list.
- Returns
A list of ChatMessageEmote objects.
- Return type
- property cheermotes: list[twitchio.models.eventsub_.ChatMessageCheermote]¶
A property that lists all of the cheermotes of a message. If no cheermotes are in the message this will return an empty list.
- Returns
A list of ChatMessageCheermote objects.
- Return type
- class twitchio.AutomodBlockedTerm¶
Represents a blocked term from AutoMod.
- owner¶
The broadcaster who has blocked the term.
- Type
- class twitchio.Boundary¶
NamedTuple that represents the boundaries of caught automod words.
- class twitchio.AutomodMessageUpdate¶
Represents an automod message update event. Both V1 and V2.
- broadcaster¶
The broadcaster specified in the request.
- Type
- moderator¶
The moderator who approved or denied the message.
- Type
- user¶
The user who sent the message.
- Type
- level¶
The level of severity. Measured between 1 to 4. This is None if the V2 endpoint is used and the reason is blocked_term.
- Type
int | None
- category¶
The category of the message. This is None if the V2 endpoint is used and the reason is blocked_term.
- Type
str | None
- held_at¶
The datetime of when automod saved the message.
- Type
- emotes¶
List of emotes in the message.
- Type
- cheermotes¶
List of cheermotes in the message.
- Type
- fragments¶
List of chat message fragments.
- Type
- status¶
The message’s status. Possible values are:
Approved
Denied
Expired
- Type
Literal[“Approved”, “Denied”, “Expired”]
- class twitchio.AutomodSettingsUpdate¶
Represents an automod settings update event.
- broadcaster¶
The broadcaster who had their automod settings updated.
- Type
- moderator¶
The moderator who changed the channel settings.
- Type
- class twitchio.AutomodTermsUpdate¶
Represents an automod terms update event.
- broadcaster¶
The broadcaster specified in the request.
- Type
- moderator¶
The moderator who changed the channel settings.
- Type
- class twitchio.AutoRedeemReward¶
Represents a reward on an automatic redeem.
- type¶
The type of the reward. V2 does not cover Power-ups e.g. gigantify_an_emote, celebration, and message_effect.
- Type
Literal[“single_message_bypass_sub_mode”, “send_highlighted_message”, “random_sub_emote_unlock”, “chosen_sub_emote_unlock”, “chosen_modified_sub_emote_unlock”, “message_effect”, “gigantify_an_emote”, “celebration”]
- emote¶
The human readable emote token.
- Type
UnlockedEmote | None
- class twitchio.ChannelUpdate¶
Represents a channel update event.
- broadcaster¶
An ID that identifies the emote set that the emote belongs to.
- Type
- class twitchio.ChannelFollow¶
Represents a channel follow event.
- broadcaster¶
The requested broadcaster to listen to follows for.
- Type
- user¶
The user that is now following the specified channel.
- Type
- followed_at¶
Datetime when the follow occurred.
- Type
- class twitchio.ChannelAdBreakBegin¶
Represents a channel ad break event.
- broadcaster¶
The broadcaster the ad was run on.
- Type
- requester¶
The user that requested the ad.
- Type
- started_at¶
Datetime when the follow occurred.
- Type
- class twitchio.ChannelBitsUse¶
Represents a channel bits use event.
- broadcaster¶
The broadcastter / channel where the Bits were redeemed.
- Type
- user¶
The redeeming user.
- Type
- fragments¶
The ordered list of chat message fragments. Is None if no chat message was used.
- Type
- class twitchio.ChannelChatClear¶
Represents a channel chat clear event.
- broadcaster¶
The broadcaster’s chat that was cleared.
- Type
- class twitchio.ChannelChatClearUserMessages¶
Represents a user’s channel chat clear event.
- broadcaster¶
The broadcaster’s chat that had the user’s messages cleared.
- Type
- user¶
The user that was banned or put in a timeout and had all their messaged deleted.
- Type
- class twitchio.BaseChatMessage¶
- property emotes: list[twitchio.models.eventsub_.ChatMessageEmote]¶
A property that lists all of the emotes of a message. If no emotes are in the message this will return an empty list.
- Returns
A list of ChatMessageEmote objects.
- Return type
- property cheermotes: list[twitchio.models.eventsub_.ChatMessageCheermote]¶
A property that lists all of the cheermotes of a message. If no cheermotes are in the message this will return an empty list.
- Returns
A list of ChatMessageCheermote objects.
- Return type
- class twitchio.ChatMessageReply¶
Represents a chat message reply.
- parent_message_id¶
An ID that uniquely identifies the parent message that this message is replying to.
- Type
- parent_user¶
The sender of the parent message.
- Type
- thread_user¶
The sender of the thread’s parent message.
- Type
- class twitchio.ChatMessageCheer¶
Represents a chat message cheer.
- class twitchio.ChatMessageBadge¶
Represents a chat message badge.
- id¶
An ID that identifies this version of the badge. The ID can be any value. For example, for Bits, the ID is the Bits tier level, but for World of Warcraft, it could be Alliance or Horde.
- Type
- asyncfetch_emote_set
- class twitchio.ChatMessageEmote¶
Represents a chat message emote.
- owner¶
The broadcaster who owns the emote.
- Type
PartialUser | None
- format¶
The formats that the emote is available in. For example, if the emote is available only as a static PNG, the array contains only static. But if the emote is available as a static PNG and an animated GIF, the array contains static and animated. The possible formats are:
animated - An animated GIF is available for this emote.
static - A static PNG file is available for this emote.
- async fetch_emote_set(*, token_for: str | twitchio.user.PartialUser | None = None) EmoteSet¶
This function is a coroutine.
Fetches emotes for this emote set.
- Parameters
token_for (str | PartialUser | None) – An optional user token to use instead of the default app token.
- Returns
A list of EmoteSet objects.
- Return type
- class twitchio.ChatMessageCheermote¶
Represents a chat message cheermote.
- prefix¶
The name portion of the Cheermote string that you use in chat to cheer Bits. The full Cheermote string is the concatenation of {prefix} + {number of Bits}. For example, if the prefix is “Cheer” and you want to cheer 100 Bits, the full Cheermote string is Cheer100. When the Cheermote string is entered in chat, Twitch converts it to the image associated with the Bits tier that was cheered.
- Type
- class twitchio.ChatMessageFragment¶
Represents a chat message’s fragments.
- type¶
The type of message fragment. Possible values:
text
cheermote
emote
mention
- Type
Literal[“text”, “cheermote”, “emote”, “mention”]
- mention¶
The user that is mentioned, if one is mentioned.
- Type
PartialUser | None
- cheermote¶
Cheermote data if a cheermote is sent.
- Type
ChatMessageCheermote | None
- emote¶
Emote data if a cheermote is sent.
- Type
ChatMessageEmote | None
- class twitchio.ChatMessage¶
Represents a chat message.
- broadcaster¶
The broadcaster whose room recieved the message.
- Type
- chatter¶
The user / chatter who sent the message.
- Type
- reply¶
Data regarding parent message and thread, if this message is a reply.
- Type
ChatMessageReply | None
- type¶
The type of message. Possible values:
text
channel_points_highlighted
channel_points_sub_only
user_intro
power_ups_message_effect
power_ups_gigantified_emote
- Type
Literal[“text”, “channel_points_highlighted”, “channel_points_sub_only”, “user_intro”, “power_ups_message_effect”, “power_ups_gigantified_emote”]
- fragments¶
The chat message fragments.
- Type
- channel_points_animation_id¶
An ID for the type of animation selected as part of an “animate my message” redemption.
- Type
str | None
- cheer¶
Data for a cheer, if received.
- Type
ChatMessageCheer | None
- badges¶
List of ChatMessageBadge for chat badges.
- Type
- source_broadcaster¶
The broadcaster of the channel the message was sent from. Is None when the message happens in the same channel as the broadcaster. Is not None when in a shared chat session, and the action happens in the channel of a participant other than the broadcaster.
- Type
PartialUser | None
- source_id¶
The source message ID from the channel the message was sent from. Is None when the message happens in the same channel as the broadcaster. Is not None when in a shared chat session, and the action happens in the channel of a participant other than the broadcaster.
- Type
str | None
- source_badges¶
The list of chat badges for the chatter in the channel the message was sent from. Is None when the message happens in the same channel as the broadcaster. Is not None when in a shared chat session, and the action happens in the channel of a participant other than the broadcaster.
- Type
- source_only¶
Whether a message delivered during a shared chat session is only sent to the source channel. This is None when not in a shared chat.
- Type
bool | None
- property mentions: list[twitchio.user.PartialUser]¶
List of PartialUsers of chatters who were mentioned in the message.
- property color: twitchio.utils.Colour | None¶
An alias for colour
- class twitchio.ChatSub¶
Represents a chat subscription.
- class twitchio.ChatResub¶
Represents a chat resubscription.
- tier¶
The type of subscription plan being used.
Type
Description
1000
First level of paid or Prime subscription.
2000
Second level of paid subscription.
3000
Third level of paid subscription.
- Type
Literal[“1000”, “2000”, “3000”]
- streak_months¶
The number of consecutive months the user’s current subscription has been active. This is None if the user has opted out of sharing this information.
- Type
- gifter¶
The user who gifted the subscription.
- Type
PartialUser | None
- class twitchio.ChatSubGift¶
Represents a chat subscription gift.
- tier¶
The type of subscription plan being used.
Type
Description
1000
First level of paid or Prime subscription.
2000
Second level of paid subscription.
3000
Third level of paid subscription.
- Type
Literal[“1000”, “2000”, “3000”]
- cumulative_total¶
The amount of gifts the gifter has given in this channel. None if anonymous.
- Type
int | None
- community_gift_id¶
The ID of the associated community gift. Mone if not associated with a community gift.
- Type
int | None
- recipient¶
The user who received the gift subscription.
- Type
- class twitchio.ChatCommunitySubGift¶
Represents a chat community subscription gift.
- tier¶
The type of subscription plan being used.
Type
Description
1000
First level of paid or Prime subscription.
2000
Second level of paid subscription.
3000
Third level of paid subscription.
- Type
Literal[“1000”, “2000”, “3000”]
- class twitchio.ChatGiftPaidUpgrade¶
Represents a paid chat subscription upgrade gift.
- gifter¶
The user who gifted the subscription. None if anonymous.
- Type
PartialUser | None
- class twitchio.ChatPrimePaidUpgrade¶
Represents a prime chat subscription upgrade.
- class twitchio.ChatPayItForward¶
Represents a pay it forward gift subscription.
- gifter¶
The user who gifted the subscription. None if anonymous.
- Type
PartialUser | None
- class twitchio.ChatAnnouncement¶
Represents a pay it forward gift subscription.
- class twitchio.ChatBitsBadgeTier¶
Represents a bits badge tier.
- class twitchio.BaseCharityCampaign¶
- class twitchio.ChatCharityDonation¶
Represents a charity donation.
- amount¶
The amount of money donation. This includes currency and decimal places.
- Type
- announcement
- anonymous
- badges
- bits_badge_tier
- broadcaster
- charity_donation
- chatter
- colour
- community_sub_gift
- fragments
- gift_paid_upgrade
- id
- notice_type
- pay_it_forward
- prime_paid_upgrade
- raid
- resub
- shared_announcement
- shared_community_sub_gift
- shared_gift_paid_upgrade
- shared_pay_it_forward
- shared_prime_paid_upgrade
- shared_raid
- shared_resub
- shared_sub
- shared_sub_gift
- sub
- sub_gift
- system_message
- text
- unraid
- class twitchio.ChatNotification¶
Represents a chat notification.
- broadcaster¶
The broadcaster / channel that received the notification.
- Type
- chatter¶
The chatter / user that sent the message.
- Type
- badges¶
A list of badges the chatter / user has.
- Type
- fragments¶
A list of chat fragments, each containing structured data related to the messages, such as:
text
cheermote
emote
mention
- Type
- notice_type¶
The type of notice. Possible values are:
sub
resub
sub_gift
community_sub_gift
gift_paid_upgrade
prime_paid_upgrade
raid
unraid
pay_it_forward
announcement
bits_badge_tier
charity_donation
shared_chat_sub
shared_chat_resub
shared_chat_community_sub_gift
shared_chat_gift_paid_upgrade
shared_chat_prime_paid_upgrade
shared_chat_raid
shared_chat_pay_it_forward
shared_chat_announcement
- Type
Literal[“sub”, “resub”, “sub_gift”, “community_sub_gift”, “gift_paid_upgrade”, “prime_paid_upgrade”, “raid”, “unraid”, “pay_it_forward”, “announcement”, “bits_badge_tier”, “charity_donation”, “shared_chat_sub”, “shared_chat_resub”, “shared_chat_community_sub_gift”, “shared_chat_gift_paid_upgrade”, “shared_chat_prime_paid_upgrade”, “shared_chat_raid”, “shared_chat_pay_it_forward”, “shared_chat_announcement”]
- sub_gift¶
Information about the gift sub event. None if notice_type is not sub_gift.
- Type
ChatSubGift | None
- community_sub_gift¶
Information about the community gift sub event. None if notice_type is not community_sub_gift.
- Type
ChatCommunitySubGift | None
- gift_paid_upgrade¶
nformation about the community gift paid upgrade event. None if notice_type is not gift_paid_upgrade.
- Type
ChatGiftPaidUpgrade | None
- prime_paid_upgrade¶
Information about the Prime gift paid upgrade event. None if notice_type is not prime_paid_upgrade.
- Type
ChatPrimePaidUpgrade | None
- unraid¶
Returns None as this is an empty payload. You will need to check the notice_type.
- Type
None
- pay_it_forward¶
Information about the pay it forward event. None if notice_type is not pay_it_forward
- Type
ChatPayItForward | None
- announcement¶
Information about the announcement event. None if notice_type is not announcement
- Type
ChatAnnouncement | None
- bits_badge_tier¶
Information about the bits badge tier event. None if notice_type is not bits_badge_tier
- Type
ChatBitsBadgeTier | None
- charity_donation¶
Information about the announcement event. None if notice_type is not charity_donation
- Type
Information about the shared_chat_sub event. Is None if notice_type is not shared_chat_sub. This field has the same information as the sub field but for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.
- Type
ChatSub | None
Information about the shared_chat_resub event. Is None if notice_type is not shared_chat_resub. This field has the same information as the resub field but for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.
- Type
ChatResub | None
Information about the shared_chat_sub_gift event. Is None if notice_type is not shared_chat_sub_gift. This field has the same information as the chat_sub_gift field but for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.
- Type
ChatSubGift | None
Information about the shared_chat_community_sub_gift event. Is None if notice_type is not shared_chat_community_sub_gift. This field has the same information as the community_sub_gift field but for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.
- Type
ChatCommunitySubGift | None
Information about the shared_chat_gift_paid_upgrade event. Is None if notice_type is not shared_chat_gift_paid_upgrade. This field has the same information as the gift_paid_upgrade field but for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.
- Type
ChatGiftPaidUpgrade | None
Information about the shared_chat_chat_prime_paid_upgrade event. Is None if notice_type is not shared_chat_prime_paid_upgrade. This field has the same information as the prime_paid_upgrade field but for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.
- Type
ChatPrimePaidUpgrade | None
Information about the shared_chat_raid event. Is None if notice_type is not shared_chat_raid. This field has the same information as the raid field but for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.
- Type
ChatRaid | None
Information about the shared_chat_pay_it_forward event. Is None if notice_type is not shared_chat_pay_it_forward. This field has the same information as the pay_it_forward field but for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.
- Type
ChatPayItForward | None
Information about the shared_chat_announcement event. Is None if notice_type is not shared_chat_announcement. This field has the same information as the announcement field but for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.
- Type
ChatAnnouncement | None
- class twitchio.ChatMessageDelete¶
Represents a chat message delete event.
- broadcaster¶
The broadcaster whose channel deleted the message.
- Type
- user¶
The user whose message was deleted.
- Type
- class twitchio.ChatSettingsUpdate¶
Represents a chat settings update event.
- broadcaster¶
The broadcaster whose channel updated their chat settings.
- Type
- slow_mode¶
Whether the broadcaster limits how often users in the chat room are allowed to send messages.
- Type
- slow_mode_wait_time¶
The amount of time, in seconds, that users need to wait between sending messages. None if slow_mode is False.
- Type
int | None
- follower_mode¶
Whether the broadcaster restricts the chat room to followers only, based on how long they’ve followed.
- Type
- follower_mode_duration¶
The length of time, in minutes, that the followers must have followed the broadcaster to participate in the chat room. None if follower_mode is False.
- Type
int | None
- subscriber_mode¶
Whether only users that subscribe to the broadcaster’s channel can talk in the chat room.
- Type
- class twitchio.ChatUserMessageHold¶
- class twitchio.ChatUserMessageUpdate¶
Represents a shared chat session begin event.
The unique identifier for the shared chat session.
- Type
The user of the channel in the subscription condition which is now active in the shared chat session.
- Type
The user of the host channel.
- Type
List of participants in the session.
- Type
Represents a shared chat session begin event.
The unique identifier for the shared chat session.
- Type
The user of the channel in the subscription condition which is now active in the shared chat session.
- Type
The user of the host channel.
- Type
List of participants in the session.
- Type
Represents a shared chat session end event.
The unique identifier for the shared chat session.
- Type
The user of the channel in the subscription condition which is no longer active in the shared chat session.
- Type
The user of the host channel.
- Type
- class twitchio.ChannelSubscribe¶
Represents a channel subscribe event.
- broadcaster¶
The broadcaster whose channel received a subscription.
- Type
- user¶
The user who subscribed to the channel.
- Type
- class twitchio.ChannelSubscriptionEnd¶
Represents a channel subscription end event.
- broadcaster¶
The broadcaster whose channel had the subscription end.
- Type
- user¶
The user whose subscription ended.
- Type
- class twitchio.ChannelSubscriptionGift¶
Represents a channel subscription gift event.
- broadcaster¶
The broadcaster whose channel received the gift subscriptions.
- Type
- user¶
The user who sent the gift. None if it was an anonymous subscription gift.
- Type
PartialUser | None
- class twitchio.SubscribeEmote¶
Represents a subscription emote.
- class twitchio.ChannelSubscriptionMessage¶
Represents a subscription message event.
- broadcaster¶
The broadcaster whose channel received a subscription message.
- Type
- user¶
The user who sent a resubscription chat message.
- Type
- tier¶
The tier of the user’s subscription. Valid values are 1000, 2000, and 3000.
- Type
Literal[“1000”, “2000”, “3000”]
- streak_months¶
The number of consecutive months the user’s current subscription has been active. None if the user has opted out of sharing this information
- Type
int | None
- emotes¶
List of emote information for the subscription message. This includes start and end positions for where the emote appears in the text.
- Type
- class twitchio.ChannelCheer¶
Represents a channel cheer event.
- broadcaster¶
The broadcaster whose channel received a cheer.
- Type
- user¶
The user who cheered on the specified channel. None if anonymous is true.
- Type
PartialUser | None
- class twitchio.ChannelRaid¶
Represents a channel raid event.
- from_broadcaster¶
The broadcaster whose channel started a raid.
- Type
- to_broadcaster¶
The broadcaster whose channel is being raided.
- Type
- class twitchio.ChannelBan¶
Represents a channel ban event.
- broadcaster¶
The broadcaster whose channel banned a user.
- Type
- user¶
The user who was banned on the specified channel.
- Type
- moderator¶
The moderator who banned the user.
- Type
- banned_at¶
The datetime of when the user was banned or put in a timeout.
- Type
- ends_at¶
The datetime of when the timeout ends. None if the user was banned instead of put in a timeout
- Type
datetime.datetime | None
- class twitchio.ChannelUnban¶
Represents a channel unban event.
- broadcaster¶
The broadcaster whose channel unbanned a user.
- Type
- user¶
The user who was unbanned on the specified channel.
- Type
- moderator¶
The moderator who unbanned the user.
- Type
- class twitchio.ChannelUnbanRequest¶
Represents a channel unban request event.
- broadcaster¶
The broadcaster whose channel received an unban request.
- Type
- user¶
The user that is requesting to be unbanned.
- Type
- created_at¶
The datetime of when the unban request was created.
- Type
- class twitchio.ChannelUnbanRequestResolve¶
Represents a channel unban request resolve event.
- broadcaster¶
The broadcaster whose channel resolved an unban request.
- Type
- user¶
The user that is requesting to be unbanned.
- Type
- moderator¶
The moderator who approved/denied the request. This is None is the user is unbanned (/unban) via chat.
- Type
PartialUser | None
- class twitchio.ModerateFollowers¶
Represents data associated with the followers command.
- class twitchio.ModerateBan¶
Represents data associated with the ban command.
- user¶
The user being banned.
- Type
- class twitchio.ModerateTimeout¶
Represents data associated with the timeout command.
- user¶
The user being timed out.
- Type
- expires_at¶
The time at which the timeout ends.
- Type
- class twitchio.ModerateSlow¶
Represents data associated with the slow command.
- class twitchio.ModerateRaid¶
Represents data associated with the raid command.
- user¶
The user being raided.
- Type
- class twitchio.ModerateDelete¶
Represents data associated with the delete command.
- user¶
The user whose message is being deleted.
- Type
- class twitchio.ModerateAutomodTerms¶
Represents data associated with the automod terms changes.
- class twitchio.ModerateUnbanRequest¶
Represents data associated with an unban request.
- user¶
The banned user.
- Type
- class twitchio.ModerateWarn¶
Represents data associated with the warn command.
- user¶
The user being warned.
- Type
- class twitchio.ChannelModerate¶
Represents a channel moderate event, both V1 and V2.
- broadcaster¶
The broadcaster who had a moderate event occur.
- Type
- source_broadcaster¶
The channel in which the action originally occurred. Is the same as broadcaster if not in shared chat.
- Type
- moderator¶
The moderator who performed the action.
- Type
- followers¶
Information associated with the followers command.
- Type
ModerateFollowers | None
- slow¶
Information associated with the slow command.
- Type
ModerateSlow | None
- vip¶
Information associated with the vip command.
- Type
PartialUser | None
- unvip¶
Information associated with the unvip command.
- Type
PartialUser | None
- mod¶
Information associated with the mod command.
- Type
PartialUser | None
- unmod¶
Information associated with the unmod command.
- Type
PartialUser | None
- ban¶
Information associated with the ban command.
- Type
ModerateBan | None
- unban¶
Information associated with the unban command.
- Type
PartialUser | None
- timeout¶
Information associated with the timeout command.
- Type
ModerateTimeout | None
- untimeout¶
Information associated with the untimeout command.
- Type
PartialUser | None
- raid¶
Information associated with the raid command.
- Type
ModerateRaid | None
- unraid¶
Information associated with the unraid command.
- Type
PartialUser | None
- delete¶
Information associated with the delete command.
- Type
ModerateDelete | None
- automod_terms¶
Information associated with the automod terms changes.
- Type
ModerateAutomodTerms | None
- unban_request¶
Information associated with an unban request.
- Type
ModerateUnbanRequest | None
Information about the shared_chat_ban event. Is None if action is not shared_chat_ban. This field has the same information as the ban field but for a action that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.
- Type
ModerateBan | None
Information about the shared_chat_unban event. Is None if action is not shared_chat_unban. This field has the same information as the unban field but for a action that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.
- Type
PartialUser | None
Information about the shared_chat_timeout event. Is None if action is not shared_chat_timeout. This field has the same information as the timeout field but for a action that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.
- Type
ModerateTimeout | None
Information about the shared_chat_untimeout event. Is None if action is not shared_chat_untimeout. This field has the same information as the untimeout field but for a action that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.
- Type
PartialUser | None
Information about the shared_chat_delete event. Is None if action is not shared_chat_delete. This field has the same information as the delete field but for a action that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.
- Type
ModerateDelete | None
- action¶
The type of action. warn is only available with V2.
ban
timeout
unban
untimeout
clear
emoteonly
emoteonlyoff
followers
followersoff
uniquechat
uniquechatoff
slow
slowoff
subscribers
subscribersoff
unraid
delete
unvip
vip
raid
add_blocked_term
add_permitted_term
remove_blocked_term
remove_permitted_term
mod
unmod
approve_unban_request
deny_unban_request
warn
shared_chat_ban
shared_chat_unban
shared_chat_timeout
shared_chat_untimeout
shared_chat_delete
- Type
Literal[“ban”,”timeout”, “unban”, “untimeout”, “clear”, “emoteonly”, “emoteonlyoff”, “followers”, “followersoff”, “uniquechat”, “uniquechatoff”, “slow”, “slowoff”, “subscribers”, “subscribersoff”, “unraid”, “delete”, “unvip”, “vip”, “raid”, “add_blocked_term”, “add_permitted_term”, “remove_blocked_term”, “remove_permitted_term”, “mod”, “unmod”, “approve_unban_request”, “deny_unban_request”, “warn”, “shared_chat_ban”, “shared_chat_unban”, “shared_chat_timeout”, “shared_chat_untimeout”, “shared_chat_delete”]
- class twitchio.ChannelModeratorAdd¶
Represents a moderator add event.
- broadcaster¶
The broadcaster who had a new moderator added.
- Type
- user¶
The new moderator.
- Type
- class twitchio.ChannelModeratorRemove¶
Represents a moderator remove event.
- broadcaster¶
The broadcaster who had a moderator removed.
- Type
- user¶
The removed moderator.
- Type
- class twitchio.ChannelPointsEmote¶
Represents a channel points emote.
- class twitchio.ChannelPointsAutoRedeemAdd¶
Represents an automatic redemption of a channel points reward.
Note
This is a combination of V1 and V2.
- broadcaster¶
The broadcaster / channel who had the reward redeemed.
- Type
- user¶
The user who redeemed the reward.
- Type
- redeemed_at¶
The datetime object of when the reward was redeemed.
- Type
- reward¶
The details of the reward auto redeemed.
V2 does not cover Power-ups e.g. gigantify_an_emote, celebration, and message_effect. Please see ChannelBitsUseSubscription for those specific types if using V2.
- Type
- emotes¶
A list of ChannelPointsEmote objects that appear in the text.
If using V1, this is populated by Twitch.
If using V2, the emotes can be found in the fragments, but we calculate the index ourselves for this property.
- Type
- user_input¶
The text input by the user if the reward requires input. This is None when using V2. text is the preferred attribute to use.
- Type
str | None
- fragments¶
The ordered list of chat message fragments. This is only populated when using V2.
- Type
- class twitchio.CooldownSettings¶
NamedTuple that represents a custom reward’s cooldown settings.
- defget_image
- class twitchio.ChannelPointsReward¶
Represents an Eventsub Custom Reward.
- broadcaster¶
The broadcaster / channel associated with the custom reward.
- Type
Partialuser
- enabled¶
Whether the reward currently enabled. If False, the reward won’t show up to viewers.
- Type
bool | None
- input_requred¶
Whether the viewer needs to enter information when redeeming the reward.
- Type
bool | None
- skip_queue¶
Should redemptions be set to fulfilled status immediately when redeemed and skip the request queue instead of the normal unfulfilled status.
- Type
bool | None
- cooldown_until¶
The cooldown expiration datetime. Is None if the reward is not on cooldown.
- Type
datetime.datetime | None
- max_per_stream¶
Whether a maximum per stream is enabled and what the maximum is.
- Type
RewardLimitSettings | None
- max_per_user_per_stream¶
Whether a maximum per user per stream is enabled and what the maximum is.
- Type
RewardLimitSettings | None
- global_cooldown¶
Whether a cooldown is enabled and what the cooldown is in seconds.
- Type
CooldownSettings | None
- default_image¶
Dictionary of default images of varying sizes for the reward.
- current_stream_redeems¶
The number of redemptions redeemed during the current live stream. Counts against the max_per_stream limit. Is None if the broadcasters stream isn’t live or max_per_stream isn’t enabled.
- Type
int | None
- property color: twitchio.utils.Colour | None¶
Alias for Colour.
- property image: dict[str, str] | None¶
Dictionary of custom images for the reward. Is None if no images have been uploaded.
- get_image(size: Literal['1x', '2x', '4x'] = '2x', use_default: bool = False) twitchio.assets.Asset | None¶
Get an image Asset for the reward at a specified size. Falls back to default images if no custom images have been uploaded or if specified.
- class twitchio.ChannelPointsRewardAdd¶
Represents an Eventsub Custom Reward that has been created for a channel.
- broadcaster¶
The broadcaster / channel associated with the custom reward.
- Type
Partialuser
- enabled¶
Whether the reward currently enabled. If False, the reward won’t show up to viewers.
- Type
- skip_queue¶
Should redemptions be set to fulfilled status immediately when redeemed and skip the request queue instead of the normal unfulfilled status.
- Type
- cooldown_until¶
The cooldown expiration datetime. Is None if the reward is not on cooldown.
- Type
datetime.datetime | None
- max_per_stream¶
Whether a maximum per stream is enabled and what the maximum is.
- Type
- max_per_user_per_stream¶
Whether a maximum per user per stream is enabled and what the maximum is.
- Type
- global_cooldown¶
Whether a cooldown is enabled and what the cooldown is in seconds.
- Type
- class twitchio.ChannelPointsRewardUpdate¶
Represents an Eventsub Custom Reward that has been updated for a channel.
- broadcaster¶
The broadcaster / channel associated with the custom reward.
- Type
Partialuser
- enabled¶
Whether the reward currently enabled. If False, the reward won’t show up to viewers.
- Type
- skip_queue¶
Should redemptions be set to fulfilled status immediately when redeemed and skip the request queue instead of the normal unfulfilled status.
- Type
- cooldown_until¶
The cooldown expiration datetime. Is None if the reward is not on cooldown.
- Type
datetime.datetime | None
- max_per_stream¶
Whether a maximum per stream is enabled and what the maximum is.
- Type
- max_per_user_per_stream¶
Whether a maximum per user per stream is enabled and what the maximum is.
- Type
- global_cooldown¶
Whether a cooldown is enabled and what the cooldown is in seconds.
- Type
- class twitchio.ChannelPointsRewardRemove¶
Represents an Eventsub Custom Reward that has been removed from a channel.
- broadcaster¶
The broadcaster / channel associated with the custom reward.
- Type
Partialuser
- enabled¶
Whether the reward currently enabled. If False, the reward won’t show up to viewers.
- Type
- skip_queue¶
Should redemptions be set to fulfilled status immediately when redeemed and skip the request queue instead of the normal unfulfilled status.
- Type
- cooldown_until¶
The cooldown expiration datetime. Is None if the reward is not on cooldown.
- Type
datetime.datetime | None
- max_per_stream¶
Whether a maximum per stream is enabled and what the maximum is.
- Type
- max_per_user_per_stream¶
Whether a maximum per user per stream is enabled and what the maximum is.
- Type
- global_cooldown¶
Whether a cooldown is enabled and what the cooldown is in seconds.
- Type
- class twitchio.ChannelPointsRedemptionAdd¶
Represents a channel points redemption add event.
- broadcaster¶
The broadcaster whose channel where the reward was redeemed.
- Type
- user¶
The user that redeemed the reward.
- Type
- status¶
The status of the redemption. Defaults to unfulfilled.
unknown
unfulfilled
fulfilled
canceled
- Type
Literal[“unknown”, “unfulfilled”, “fulfilled”, “canceled”]
- redeemed_at¶
Datetime when the reward was redeemed.
- Type
- reward¶
Information about the reward that was redeemed, at the time it was redeemed.
- Type
- async fulfill(*, token_for: str | PartialUser) CustomRewardRedemption¶
This function is a coroutine.
Updates the redemption’s status to FULFILLED.
Note
Requires a user access token that includes the
channel:manage:redemptionsscope.- Parameters
token_for (str | PartialUser) – The user’s token that has permission manage the broadcaster’s reward redemptions.
- Return type
- async refund(*, token_for: str | PartialUser) CustomRewardRedemption¶
This function is a coroutine.
Updates the redemption’s status to CANCELED.
Note
Requires a user access token that includes the
channel:manage:redemptionsscope.- Parameters
token_for (str | PartialUser) – The user’s token that has permission manage the broadcaster’s reward redemptions.
- Return type
- class twitchio.ChannelPointsRedemptionUpdate¶
Represents a channel points redemption update event.
- broadcaster¶
The broadcaster whose channel where the reward was redeemed.
- Type
- user¶
The user that redeemed the reward.
- Type
- status¶
The status of the redemption. Will be fulfilled or canceled.
unknown
unfulfilled
fulfilled
canceled
- Type
Literal[“unknown”, “unfulfilled”, “fulfilled”, “canceled”]
- redeemed_at¶
Datetime when the reward was redeemed.
- Type
- reward¶
Information about the reward that was redeemed, at the time it was redeemed.
- Type
- class twitchio.PollVoting¶
NamedTuple that represents a channel poll’s voting settings.
- class twitchio.ChannelPollBegin¶
Represents a channel poll begin event.
- broadcaster¶
The broadcaster whose channel started a poll.
- Type
- choices¶
A list of choices for the poll.
- Type
- channel_points_voting¶
The channel points voting settings.
- Type
- started_at¶
The time the poll started.
- Type
- ends_at¶
The time the poll will end.
- Type
- class twitchio.ChannelPollProgress¶
Represents a channel poll progress event.
- broadcaster¶
The broadcaster whose channel had received a poll update.
- Type
- choices¶
A list of choices for the poll.
- Type
- channel_points_voting¶
The channel points voting settings.
- Type
- started_at¶
The time the poll started.
- Type
- ends_at¶
The time the poll will end.
- Type
- class twitchio.ChannelPollEnd¶
Represents a channel poll begin event.
- broadcaster¶
The broadcaster whose channel had received a poll update.
- Type
- choices¶
A list of choices for the poll.
- Type
- channel_points_voting¶
The channel points voting settings.
- Type
- status¶
The status of the poll. Valid values are:
completed
archived
terminated
- Type
Literal[“completed”, “terminated”, “archived”]
- started_at¶
The time the poll started.
- Type
- ended_at¶
The time the poll ended.
- Type
- class twitchio.ChannelPredictionBegin¶
Represents a channel points prediction begin event.
- broadcaster¶
The broadcaster whose channel started a prediction.
- Type
- outcomes¶
A list of outcomes for the predictions. Only id, title and colour will be populated.
- Type
- started_at¶
The time the prediction started.
- Type
- locks_at¶
The time the prediction will automatically lock.
- Type
- class twitchio.ChannelPredictionProgress¶
Represents a channel points prediction progress event.
- broadcaster¶
The broadcaster whose channel started a prediction.
- Type
- outcomes¶
A list of outcomes for the predictions.
- Type
- started_at¶
The time the prediction started.
- Type
- locks_at¶
The time the prediction will automatically lock.
- Type
- class twitchio.ChannelPredictionLock¶
Represents a channel points prediction progress event.
- broadcaster¶
The broadcaster whose channel started a prediction.
- Type
- outcomes¶
A list of outcomes for the predictions.
- Type
- started_at¶
The time the prediction started.
- Type
- locked_at¶
The time the prediction was locked.
- Type
- class twitchio.ChannelPredictionEnd¶
Represents a channel points prediction progress event.
- broadcaster¶
The broadcaster whose channel started a prediction.
- Type
- outcomes¶
A list of outcomes for the predictions.
- Type
- winning_outcome¶
The winning outcome. This can be None if the prediction is deleted.
- Type
PredictionOutcome | None
- started_at¶
The time the prediction started.
- Type
- ended_at¶
The time the prediction ended.
- Type
- class twitchio.SuspiciousUserUpdate¶
Represents a suspicious user update event.
- broadcaster¶
The broadcaster whose channel had the treatment for a suspicious user was updated.
- Type
- user¶
The suspicious user whose treatment was updated.
- Type
- moderator¶
The moderator that updated the treatment for a suspicious user.
- Type
- class twitchio.SuspiciousUserMessage¶
Represents a suspicious user message event.
- broadcaster¶
The broadcaster whose channel had the treatment for a suspicious user was updated.
- Type
- user¶
The user that sent the message.
- Type
- low_trust_status¶
The status set for the suspicious user. Can be the following:
none
active_monitoring
restricted
- Type
Literal[“none”, “active_monitoring”, “restricted”]
- types¶
User types (if any) that apply to the suspicious user. Can be the following:
manually_added
ban_evader
banned_in_shared_channel
- evaluation¶
A ban evasion likelihood value (if any) that as been applied to the user automatically by Twitch. Can be:
unknown
possible
likely
- Type
Literal[“unknown”, “possible”, “likely”]
- message¶
The chat message.
- Type
- class twitchio.ChannelVIPAdd¶
Represents a channel VIP remove event.
- broadcaster¶
The broadcaster whose channel had a VIP added.
- Type
- user¶
The user who was added as a VIP.
- Type
- class twitchio.ChannelVIPRemove¶
Represents a channel VIP remove event.
- broadcaster¶
The broadcaster whose channel had a VIP removed.
- Type
- user¶
The user who was removed as a VIP.
- Type
- class twitchio.ChannelWarningAcknowledge¶
Represents a channel warning acknowledge event.
- broadcaster¶
The broadcaster whose channel sent a warning.
- Type
- user¶
The user that has acknowledged their warning.
- Type
- class twitchio.ChannelWarningSend¶
Represents a channel warning send event.
- broadcaster¶
The broadcaster whose channel sent a warning.
- Type
- user¶
The user being warned.
- Type
- moderator¶
The moderator who sent the warning.
- Type
- class twitchio.CharityCampaignDonation¶
Represents a charity campaign donation event.
- broadcaster¶
The broadcaster that’s running the campaign.
- Type
- user¶
The user that donated to the campaign.
- Type
- charity¶
The charity associated with the campaign.
- Type
- amount¶
The amount of money donated.
- Type
- class twitchio.CharityCampaignStart¶
Represents a charity campaign start event.
- broadcaster¶
The broadcaster that’s running the campaign.
- Type
- current¶
The current amount of donations that the campaign has received.
- Type
- target¶
The target amount of donations that the campaign has received.
- Type
- started_at¶
Datetime of when the broadcaster started the campaign.
- Type
- class twitchio.CharityCampaignProgress¶
Represents a charity campaign progress event.
- broadcaster¶
The broadcaster that’s running the campaign.
- Type
- current¶
The current amount of donations that the campaign has received.
- Type
- target¶
The target amount of donations that the campaign has received.
- Type
- class twitchio.CharityCampaignStop¶
Represents a charity campaign stop event.
- broadcaster¶
The broadcaster that’s running the campaign.
- Type
- current¶
The current amount of donations that the campaign has received.
- Type
- target¶
The target amount of donations that the campaign has received.
- Type
- stopped_at¶
Datetime of when the broadcaster stopped the campaign.
- Type
- class twitchio.GoalBegin¶
Represents a goal begin event.
- broadcaster¶
The broadcaster who started a goal.
- Type
- type¶
The type of goal.
type
Description
follow
The goal is to increase followers.
subscription
The goal is to increase subscriptions. This type shows the net increase or decrease in tier points associated with the subscriptions.
subscription_count
The goal is to increase subscriptions. This type shows the net increase or decrease in the number of subscriptions.
new_subscription
The goal is to increase subscriptions. This type shows only the net increase in tier points associated with the subscriptions (it does not account for users that unsubscribed since the goal started).
new_subscription_count
The goal is to increase subscriptions. This type shows only the net increase in the number of subscriptions (it does not account for users that unsubscribed since the goal started).
new_bit
The goal is to increase the amount of Bits used on the channel.
new_cheerer
The goal is to increase the number of unique Cheerers to Cheer on the channel.
- Type
Literal[“follow”, “subscription”, “subscription_count”, “new_subscription”, “new_subscription_count”, “new_bit”, “new_cheerer”]
- description¶
A description of the goal, if specified. The description may contain a maximum of 40 characters.
- Type
- current_amount¶
The goal’s current value. The goal’s type determines how this value is increased or decreased.
type
Description
follow
This number increases with new followers and decreases when users unfollow the broadcaster.
subscription
This number is increased and decreased by the points value associated with the subscription tier. For example, if a tier-two subscription is worth 2 points, this field is increased or decreased by 2, not 1.
subscription_count
This field is increased by 1 for each new subscription and decreased by 1 for each user that unsubscribes.
new_subscription
This field is increased by the points value associated with the subscription tier. For example, if a tier-two subscription is worth 2 points, this field is increased by 2, not 1.
new_subscription_count
This field is increased by 1 for each new subscription.
- Type
- target_amount¶
The goal’s target value. For example, if the broadcaster has 200 followers before creating the goal, and their goal is to double that number, this field is set to 400.
- Type
- started_at¶
The datetime when the broadcaster started the goal.
- Type
- class twitchio.GoalProgress¶
Represents a goal progress event.
- broadcaster¶
The broadcaster whose goal progressed.
- Type
- type¶
The type of goal.
type
Description
follow
The goal is to increase followers.
subscription
The goal is to increase subscriptions. This type shows the net increase or decrease in tier points associated with the subscriptions.
subscription_count
The goal is to increase subscriptions. This type shows the net increase or decrease in the number of subscriptions.
new_subscription
The goal is to increase subscriptions. This type shows only the net increase in tier points associated with the subscriptions (it does not account for users that unsubscribed since the goal started).
new_subscription_count
The goal is to increase subscriptions. This type shows only the net increase in the number of subscriptions (it does not account for users that unsubscribed since the goal started).
new_bit
The goal is to increase the amount of Bits used on the channel.
new_cheerer
The goal is to increase the number of unique Cheerers to Cheer on the channel.
- Type
Literal[“follow”, “subscription”, “subscription_count”, “new_subscription”, “new_subscription_count”, “new_bit”, “new_cheerer”]
- description¶
A description of the goal, if specified. The description may contain a maximum of 40 characters.
- Type
- current_amount¶
The goal’s current value. The goal’s type determines how this value is increased or decreased.
type
Description
follow
This number increases with new followers and decreases when users unfollow the broadcaster.
subscription
This number is increased and decreased by the points value associated with the subscription tier. For example, if a tier-two subscription is worth 2 points, this field is increased or decreased by 2, not 1.
subscription_count
This field is increased by 1 for each new subscription and decreased by 1 for each user that unsubscribes.
new_subscription
This field is increased by the points value associated with the subscription tier. For example, if a tier-two subscription is worth 2 points, this field is increased by 2, not 1.
new_subscription_count
This field is increased by 1 for each new subscription.
- Type
- target_amount¶
The goal’s target value. For example, if the broadcaster has 200 followers before creating the goal, and their goal is to double that number, this field is set to 400.
- Type
- started_at¶
The datetime when the broadcaster started the goal.
- Type
- class twitchio.GoalEnd¶
Represents a goal end event.
- broadcaster¶
The broadcaster whose goal ended.
- Type
- type¶
The type of goal.
type
Description
follow
The goal is to increase followers.
subscription
The goal is to increase subscriptions. This type shows the net increase or decrease in tier points associated with the subscriptions.
subscription_count
The goal is to increase subscriptions. This type shows the net increase or decrease in the number of subscriptions.
new_subscription
The goal is to increase subscriptions. This type shows only the net increase in tier points associated with the subscriptions (it does not account for users that unsubscribed since the goal started).
new_subscription_count
The goal is to increase subscriptions. This type shows only the net increase in the number of subscriptions (it does not account for users that unsubscribed since the goal started).
new_bit
The goal is to increase the amount of Bits used on the channel.
new_cheerer
The goal is to increase the number of unique Cheerers to Cheer on the channel.
- Type
Literal[“follow”, “subscription”, “subscription_count”, “new_subscription”, “new_subscription_count”, “new_bit”, “new_cheerer”]
- description¶
A description of the goal, if specified. The description may contain a maximum of 40 characters.
- Type
- current_amount¶
The goal’s current value. The goal’s type determines how this value is increased or decreased.
type
Description
follow
This number increases with new followers and decreases when users unfollow the broadcaster.
subscription
This number is increased and decreased by the points value associated with the subscription tier. For example, if a tier-two subscription is worth 2 points, this field is increased or decreased by 2, not 1.
subscription_count
This field is increased by 1 for each new subscription and decreased by 1 for each user that unsubscribes.
new_subscription
This field is increased by the points value associated with the subscription tier. For example, if a tier-two subscription is worth 2 points, this field is increased by 2, not 1.
new_subscription_count
This field is increased by 1 for each new subscription.
- Type
- target_amount¶
The goal’s target value. For example, if the broadcaster has 200 followers before creating the goal, and their goal is to double that number, this field is set to 400.
- Type
- started_at¶
The datetime when the broadcaster started the goal.
- Type
- ended_at¶
The datetime when the broadcaster ended the goal.
- Type
- class twitchio.HypeTrainBegin¶
Represents a hype train begin event.
- broadcaster¶
The broadcaster who has a hype train begin.
- Type
- top_contributions¶
The contributors with the most points contributed.
- Type
- last_contribution¶
The most recent contribution.
- started_at¶
The datetime of when the hype train started.
- Type
- expires_at¶
The datetime when the hype train expires. The expiration is extended when the hype train reaches a new level.
- Type
- class twitchio.HypeTrainProgress¶
Represents a hype train progress event.
- broadcaster¶
The broadcaster whose hype train progressed.
- Type
- top_contributions¶
The contributors with the most points contributed.
- Type
- last_contribution¶
The most recent contribution.
- started_at¶
The datetime of when the hype train started.
- Type
- expires_at¶
The datetime when the hype train expires. The expiration is extended when the hype train reaches a new level.
- Type
- class twitchio.HypeTrainEnd¶
Represents a hype train end event.
- broadcaster¶
The broadcaster whose hype train has ended.
- Type
- top_contributions¶
The contributors with the most points contributed.
- Type
- started_at¶
The datetime of when the hype train started.
- Type
- ended_at¶
The datetime of when the hype train ended.
- Type
- cooldown_until¶
The datetime when the hype train cooldown ends so that the next hype train can start.
- Type
- class twitchio.PowerUp¶
Represents a PowerUp on a channel bits use event.
- emote¶
Emote associated with the reward. Is None if no emote was used.
- Type
PowerUpEmote | None
- class twitchio.PowerUpEmote¶
Represents a PowerUp Emote on a channel bits use event.
- class twitchio.ShieldModeBegin¶
Represents a shield mode begin event.
- broadcaster¶
The broadcaster whose shield mode status was updated.
- Type
- moderator¶
The moderator that updated the shield mode status. This will be the same as the broadcaster if the broadcaster updated the status.
- Type
- started_at¶
The UTC datetime of when the moderator activated shield mode.
- Type
- class twitchio.ShieldModeEnd¶
Represents a shield mode end event.
- broadcaster¶
The broadcaster whose shield mode status was updated.
- Type
- moderator¶
The moderator that updated the shield mode status. This will be the same as the broadcaster if the broadcaster updated the status.
- Type
- ended_at¶
The UTC datetime of when the moderator deactivated shield mode.
- Type
- class twitchio.ShoutoutCreate¶
Represents a shoutout create event.
- broadcaster¶
The broadcaster that sent the shoutout.
- Type
- moderator¶
The moderator that sent the shoutout. This may be the same as the broadcaster.
- Type
- to_broadcaster¶
The broadcaster that received the shoutout.
- Type
- viewer_count¶
The number of users that were watching the broadcaster’s stream at the time of the shoutout.
- Type
- started_at¶
The UTC datetime of when the moderator sent the shoutout.
- Type
- cooldown_until¶
The UTC datetime of when the broadcaster may send a shoutout to a different broadcaster.
- Type
- target_cooldown_until¶
The UTC datetime of when the broadcaster may send another shoutout to the to_broadcaster again.
- Type
- class twitchio.ShoutoutReceive¶
Represents a shoutout received event.
- broadcaster¶
The broadcaster that received the shoutout.
- Type
- from_broadcaster¶
The broadcaster that sent the shoutout.
- Type
- viewer_count¶
The number of users that were watching the from_broadcaster’s stream at the time of the shoutout.
- Type
- started_at¶
The UTC datetime of when the moderator sent the shoutout.
- Type
- class twitchio.StreamOnline¶
Represents a stream online event.
- broadcaster¶
The user whose stream is now online.
- Type
- type¶
The stream type. Valid values are:
live
playlist
watch_party
premiere
rerun
- Type
Literal[“live”, “playlist”, “watch_party”, “premiere”, “rerun”]
- started_at¶
The datetime of when the stream started.
- Type
- class twitchio.StreamOffline¶
Represents a stream offline event.
- broadcaster¶
The user whose stream is now offline.
- Type
- class twitchio.SubscriptionRevoked¶
Represents a revoked eventsub subscription by Twitch.
- raw¶
The raw payload of the revoked subscription as a TypedDict.
- Type
RevocationSubscription
- status¶
The status provides the reason as to why the subscription was revoked by Twitch.
- Type
RevocationReason
- transport_method¶
The transport method of the subscription.
- Type
- transport_data¶
The data pertaining to the transport of the subscription. This will contain session_id or callback url depending on the transport method.
- Type
RevocationTransport
- created_at¶
The datetime that the subscription was created.
- Type
- class twitchio.UserAuthorizationGrant¶
Represents a user authorisation grant event.
Note
This subscription type is only supported by webhooks, and cannot be used with WebSockets.
- user¶
The user who has granted authorization for your client id.
- Type
- class twitchio.UserAuthorizationRevoke¶
Represents a user authorisation reoke event.
Note
This subscription type is only supported by webhooks, and cannot be used with WebSockets.
The user.id will always be populated but user.name can be None if the user no longer exists.
- user¶
The user who has revoked authorization for your client id.
- Type
- class twitchio.UnlockedEmote¶
Represents an Unlocked Emote on an automatic redeem.
- class twitchio.UserUpdate¶
Represents a user update event.
Note
The email attribute requires the user:read:email scope otherwise it is None.
- user¶
The user who has updated their account.
- Type