Objects used by EventSub#

class twitchAPI.object.eventsub.ChannelPollBeginEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelPollBeginData#

class twitchAPI.object.eventsub.ChannelUpdateEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelUpdateData#

class twitchAPI.object.eventsub.ChannelFollowEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelFollowData#

class twitchAPI.object.eventsub.ChannelSubscribeEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelSubscribeData#

class twitchAPI.object.eventsub.ChannelSubscriptionEndEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelSubscribeData#

class twitchAPI.object.eventsub.ChannelSubscriptionGiftEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelSubscriptionGiftData#

class twitchAPI.object.eventsub.ChannelSubscriptionMessageEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelSubscriptionMessageData#

class twitchAPI.object.eventsub.ChannelCheerEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelCheerData#

class twitchAPI.object.eventsub.ChannelRaidEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelRaidData#

class twitchAPI.object.eventsub.ChannelBanEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelBanData#

class twitchAPI.object.eventsub.ChannelUnbanEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelUnbanData#

class twitchAPI.object.eventsub.ChannelModeratorAddEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelModeratorAddData#

class twitchAPI.object.eventsub.ChannelModeratorRemoveEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelModeratorRemoveData#

class twitchAPI.object.eventsub.ChannelPointsCustomRewardAddEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelPointsCustomRewardData#

class twitchAPI.object.eventsub.ChannelPointsCustomRewardUpdateEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelPointsCustomRewardData#

class twitchAPI.object.eventsub.ChannelPointsCustomRewardRemoveEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelPointsCustomRewardData#

class twitchAPI.object.eventsub.ChannelPointsCustomRewardRedemptionAddEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelPointsCustomRewardRedemptionData#

class twitchAPI.object.eventsub.ChannelPointsCustomRewardRedemptionUpdateEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelPointsCustomRewardRedemptionData#

class twitchAPI.object.eventsub.ChannelPollProgressEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelPollProgressData#

class twitchAPI.object.eventsub.ChannelPollEndEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelPollEndData#

class twitchAPI.object.eventsub.ChannelPredictionEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelPredictionData#

class twitchAPI.object.eventsub.ChannelPredictionEndEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelPredictionEndData#

class twitchAPI.object.eventsub.DropEntitlementGrantEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: DropEntitlementGrantData#

class twitchAPI.object.eventsub.ExtensionBitsTransactionCreateEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ExtensionBitsTransactionCreateData#

class twitchAPI.object.eventsub.GoalEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: GoalData#

class twitchAPI.object.eventsub.HypeTrainEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: HypeTrainData#

class twitchAPI.object.eventsub.HypeTrainEndEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: HypeTrainEndData#

class twitchAPI.object.eventsub.StreamOnlineEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: StreamOnlineData#

class twitchAPI.object.eventsub.StreamOfflineEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: StreamOfflineData#

class twitchAPI.object.eventsub.UserAuthorizationGrantEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: UserAuthorizationGrantData#

class twitchAPI.object.eventsub.UserAuthorizationRevokeEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: UserAuthorizationRevokeData#

class twitchAPI.object.eventsub.UserUpdateEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: UserUpdateData#

class twitchAPI.object.eventsub.ShieldModeEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ShieldModeData#

class twitchAPI.object.eventsub.CharityCampaignStartEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: CharityCampaignStartData#

class twitchAPI.object.eventsub.CharityCampaignProgressEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: CharityCampaignProgressData#

class twitchAPI.object.eventsub.CharityCampaignStopEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: CharityCampaignStopData#

class twitchAPI.object.eventsub.CharityDonationEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: CharityDonationData#

class twitchAPI.object.eventsub.ChannelShoutoutCreateEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelShoutoutCreateData#

class twitchAPI.object.eventsub.ChannelShoutoutReceiveEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelShoutoutReceiveData#

class twitchAPI.object.eventsub.ChannelChatClearEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelChatClearData#

class twitchAPI.object.eventsub.ChannelChatClearUserMessagesEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelChatClearUserMessagesData#

class twitchAPI.object.eventsub.ChannelChatMessageDeleteEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelChatMessageDeleteData#

class twitchAPI.object.eventsub.ChannelChatNotificationEvent#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

subscription: Subscription#

event: ChannelChatNotificationData#

class twitchAPI.object.eventsub.Subscription#

Bases: TwitchObject

condition: dict#

cost: int#

created_at: datetime#

id: str#

status: str#

transport: dict#

type: str#

version: str#

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelPollBeginData#

Bases: TwitchObject

id: str#: ID of the poll

broadcaster_user_id: str#: The requested broadcaster ID

broadcaster_user_login: str#: The requested broadcaster login

broadcaster_user_name: str#: The requested broadcaster display name

title: str#: Question displayed for the poll

choices: List[PollChoice]#: Array of choices for the poll

bits_voting: BitsVoting#: Not supported

channel_points_voting: ChannelPointsVoting#: The Channel Points voting settings for the Poll

started_at: datetime#: The time the poll started

ends_at: datetime#: The time the poll will end

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.PollChoice#

Bases: TwitchObject

id: str#: ID for the choice

title: str#: Text displayed for the choice

bits_votes: int#: Not used; will be stet to 0

channel_points_votes: int#: Number of votes received via Channel Points

votes: int#: Total number of votes received for the choice across all methods of voting

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.BitsVoting#

Bases: TwitchObject

is_enabled: bool#: Not used; will be set to False

amount_per_vote: int#: Not used; will be set to 0

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelPointsVoting#

Bases: TwitchObject

is_enabled: bool#: Indicates if Channel Points can be used for Voting

amount_per_vote: int#: Number of Channel Points required to vote once with Channel Points

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelUpdateData#

Bases: TwitchObject

broadcaster_user_id: str#: The broadcaster’s user ID

broadcaster_user_login: str#: The broadcaster’s user login

broadcaster_user_name: str#: The broadcaster’s user display name

title: str#: The channel’s stream title

language: str#: The channel’s broadcast language

category_id: str#: The channel´s category ID

category_name: str#: The category name

content_classification_labels: List[str]#: Array of classification label IDs currently applied to the Channel

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelFollowData#

Bases: TwitchObject

user_id: str#: The user ID for the user now following the specified channel

user_login: str#: The user login for the user now following the specified channel

user_name: str#: The user display name for the user now following the specified channel

broadcaster_user_id: str#: The requested broadcaster’s user ID

broadcaster_user_login: str#: The requested broadcaster’s user login

broadcaster_user_name: str#: The requested broadcaster’s user display name

followed_at: datetime#: when the follow occured

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelSubscribeData#

Bases: TwitchObject

user_id: str#: The user ID for the user who subscribed to the specified channel

user_login: str#: The user login for the user who subscribed to the specified channel

user_name: str#: The user display name for the user who subscribed to the specified channel

broadcaster_user_id: str#: The requested broadcaster’s user ID

broadcaster_user_login: str#: The requested broadcaster’s user login

broadcaster_user_name: str#: The requested broadcaster’s user display name

tier: str#: The tier of the subscription. Valid values are 1000, 2000, and 3000

is_gift: bool#: Whether the subscription is a gift

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelSubscriptionEndData#

Bases: TwitchObject

user_id: str#: The user ID for the user whose subscription ended

user_login: str#: The user login for the user whose subscription ended

user_name: str#: The user display name for the user whose subscription ended

broadcaster_user_id: str#: The requested broadcaster’s user ID

broadcaster_user_login: str#: The requested broadcaster’s user login

broadcaster_user_name: str#: The requested broadcaster’s user display name

tier: str#: The tier of the subscription that ended. Valid values are 1000, 2000, and 3000

is_gift: bool#: Whether the subscription was a gift

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelSubscriptionGiftData#

Bases: TwitchObject

user_id: Optional[str]#: The user ID for the user who sent the subscription gift. None if it was an anonymous subscription gift.

user_login: Optional[str]#: The user login for the user who sent the subscription gift. None if it was an anonymous subscription gift.

user_name: Optional[str]#: The user display name for the user who sent the subscription gift. None if it was an anonymous subscription gift.

broadcaster_user_id: str#: The requested broadcaster’s user ID

broadcaster_user_login: str#: The requested broadcaster’s user login

broadcaster_user_name: str#: The requested broadcaster’s user display name

total: int#: The number of subscriptions in teh subscription gift

tier: str#: The tier of the subscription that ended. Valid values are 1000, 2000, and 3000

cumulative_total: Optional[int]#: The number of subscriptions giftet by this user in teh channel. None for anonymous gifts or if the gifter has opted out of sharing this information

is_anonymous: bool#: Whether the subscription gift was anonymous

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelSubscriptionMessageData#

Bases: TwitchObject

user_id: str#: The user ID for the user who sent a resubscription chat message

user_login: str#: The user login for the user who sent a resubscription chat message

user_name: str#: The user display name for the user who sent a resubscription chat message

broadcaster_user_id: str#: The requested broadcaster’s user ID

broadcaster_user_login: str#: The requested broadcaster’s user login

broadcaster_user_name: str#: The requested broadcaster’s user display name

tier: str#: The tier of the user´s subscription

message: SubscriptionMessage#: An object that contains the resubscription message and emote information needed to recreate the message.

cumulative_months: Optional[int]#: The number of consecutive months the user’s current subscription has been active. None if the user has opted out of sharing this information.

duration_months: int#: The month duration of the subscription

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.SubscriptionMessage#

Bases: TwitchObject

text: str#: the text of the resubscription chat message

emotes: List[Emote]#: An array that includes the emote ID and start and end positions for where the emote appears in the text

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.Emote#

Bases: TwitchObject

begin: int#: The index of where the Emote starts in the text

end: int#: The index of where the Emote ends in the text

id: str#: The emote ID

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelCheerData#

Bases: TwitchObject

is_anonymous: bool#: Whether the user cheered anonymously or not

user_id: Optional[str]#: The user ID for the user who cheered on the specified channel. None if is_anonymous is True.

user_login: Optional[str]#: The user login for the user who cheered on the specified channel. None if is_anonymous is True.

user_name: Optional[str]#: The user display name for the user who cheered on the specified channel. None if is_anonymous is True.

broadcaster_user_id: str#: The requested broadcaster’s user ID

broadcaster_user_login: str#: The requested broadcaster’s user login

broadcaster_user_name: str#: The requested broadcaster’s user display name

message: str#: The message sent with the cheer

bits: int#: The number of bits cheered

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelRaidData#

Bases: TwitchObject

from_broadcaster_user_id: str#: The broadcaster id that created the raid

from_broadcaster_user_login: str#: The broadcaster login that created the raid

from_broadcaster_user_name: str#: The broadcaster display name that created the raid

to_broadcaster_user_id: str#: The broadcaster id that received the raid

to_broadcaster_user_login: str#: The broadcaster login that received the raid

to_broadcaster_user_name: str#: The broadcaster display name that received the raid

viewers: int#: The number of viewers in the raid

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelBanData#

Bases: TwitchObject

user_id: str#: The user ID for the user who was banned on the specified channel

user_login: str#: The user login for the user who was banned on the specified channel

user_name: str#: The user display name for the user who was banned on the specified channel

broadcaster_user_id: str#: The requested broadcaster ID

broadcaster_user_login: str#: The requested broadcaster login

broadcaster_user_name: str#: The requested broadcaster display name

moderator_user_id: str#: The user ID of the issuer of the ban

moderator_user_login: str#: The user login of the issuer of the ban

moderator_user_name: str#: The user display name of the issuer of the ban

reason: str#: The reason behind the ban

banned_at: datetime#: The timestamp of when the user was banned or put in a timeout

ends_at: Optional[datetime]#: The timestamp of when the timeout ends. None if the user was banned instead of put in a timeout.

is_permanent: bool#: Indicates whether the ban is permanent (True) or a timeout (False). If True, ends_at will be None.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelUnbanData#

Bases: TwitchObject

user_id: str#: The user ID for the user who was unbanned on the specified channel

user_login: str#: The user login for the user who was unbanned on the specified channel

user_name: str#: The user display name for the user who was unbanned on the specified channel

broadcaster_user_id: str#: The requested broadcaster ID

broadcaster_user_login: str#: The requested broadcaster login

broadcaster_user_name: str#: The requested broadcaster display name

moderator_user_id: str#: The user ID of the issuer of the unban

moderator_user_login: str#: The user login of the issuer of the unban

moderator_user_name: str#: The user display name of the issuer of the unban

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelModeratorAddData#

Bases: TwitchObject

broadcaster_user_id: str#: The requested broadcaster ID

broadcaster_user_login: str#: The requested broadcaster login

broadcaster_user_name: str#: The requested broadcaster display name

user_id: str#: The user ID of the new moderator

user_login: str#: The user login of the new moderator

user_name: str#: The user display name of the new moderator

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelModeratorRemoveData#

Bases: TwitchObject

broadcaster_user_id: str#: The requested broadcaster ID

broadcaster_user_login: str#: The requested broadcaster login

broadcaster_user_name: str#: The requested broadcaster display name

user_id: str#: The user ID of the removed moderator

user_login: str#: The user login of the removed moderator

user_name: str#: The user display name of the removed moderator

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelPointsCustomRewardData#

Bases: TwitchObject

id: str#: The reward identifier

broadcaster_user_id: str#: The requested broadcaster ID

broadcaster_user_login: str#: The requested broadcaster login

broadcaster_user_name: str#: The requested broadcaster display name

is_enabled: bool#: Is the reward currently enabled. If False, the reward won’t show up to viewers.

is_paused: bool#: Is the reward currently paused. If True, viewers can’t redeem.

is_in_stock: bool#: Is the reward currently in stock. If False, viewers can’t redeem.

title: str#: The reward title

cost: int#: The reward cost

prompt: str#: The reward description

is_user_input_required: bool#: Does the viewer need to enter information when redeeming the reward

should_redemptions_skip_request_queue: bool#: Should redemptions be set to fulfilled status immediately when redeemed and skip the request queue instead of the normal unfulfilled status.

max_per_stream: MaxPerStream#: Whether a maximum per stream is enabled and what the maximum is

max_per_user_per_stream: MaxPerUserPerStream#: Whether a maximum per user per stream is enabled and what the maximum is

background_color: str#: Custom background color for the reward. Format: Hex with # prefix.

image: Optional[Image]#: Set of custom images for the reward. None if no images have been uploaded

default_image: Image#: Set of default images for the reward

global_cooldown: GlobalCooldown#: Whether a cooldown is enabled and what the cooldown is in seconds

cooldown_expires_at: Optional[datetime]#: Timestamp of the cooldown expiration. None if the reward is not on cooldown.

redemptions_redeemed_current_stream: Optional[int]#: The number of redemptions redeemed during the current live stream. Counts against the max_per_stream limit. None if the broadcasters stream is not live or max_per_stream isn not enabled.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.GlobalCooldown#

Bases: TwitchObject

is_enabled: bool#: Is the setting enabled

seconds: int#: The cooldown in seconds

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.Image#

Bases: TwitchObject

url_1x: str#: URL for the image at 1x size

url_2x: str#: URL for the image at 2x size

url_4x: str#: URL for the image at 4x size

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.MaxPerStream#

Bases: TwitchObject

is_enabled: bool#: Is the setting enabled

value: int#: The max per stream limit

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.MaxPerUserPerStream#

Bases: TwitchObject

is_enabled: bool#: Is the setting enabled

value: int#: The max per user per stream limit

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelPointsCustomRewardRedemptionData#

Bases: TwitchObject

id: str#: The redemption identifier

broadcaster_user_id: str#: The requested broadcaster ID

broadcaster_user_login: str#: The requested broadcaster login

broadcaster_user_name: str#: The requested broadcaster display name

user_id: str#: User ID of the user the redeemed the reward

user_login: str#: Login of the user the redeemed the reward

user_name: str#: Display name of the user the redeemed the reward

user_input: str#: The user input provided. Empty if not provided.

status: str#: Defaults to unfulfilled. Possible values are: unknown, unfulfilled, fulfilled and canceled

reward: Reward#: Basic information about the reward that was redeemed, at the time it was redeemed

redeemed_at: datetime#: Timestamp of when the reward was redeemed

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.Reward#

Bases: TwitchObject

id: str#: The reward identifier

title: str#: The reward name

cost: int#: The reward cost

prompt: str#: The reward description

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelPollProgressData#

Bases: TwitchObject

id: str#: ID of the poll

broadcaster_user_id: str#: The requested broadcaster ID

broadcaster_user_login: str#: The requested broadcaster login

broadcaster_user_name: str#: The requested broadcaster display name

title: str#: Question displayed for the poll

choices: List[PollChoice]#: An array of choices for the poll. Includes vote counts.

bits_voting: BitsVoting#: not supported

channel_points_voting: ChannelPointsVoting#: The Channel Points voting settings for the poll

started_at: datetime#: The time the poll started

ends_at: datetime#: The time the poll will end

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelPollEndData#

Bases: TwitchObject

id: str#: ID of the poll

broadcaster_user_id: str#: The requested broadcaster ID

broadcaster_user_login: str#: The requested broadcaster login

broadcaster_user_name: str#: The requested broadcaster display name

title: str#: Question displayed for the poll

choices: List[PollChoice]#: An array of choices for the poll. Includes vote counts.

bits_voting: BitsVoting#: not supported

channel_points_voting: ChannelPointsVoting#: The Channel Points voting settings for the poll

status: str#: The status of the poll. Valid values are completed, archived and terminated.

started_at: datetime#: The time the poll started

ends_at: datetime#: The time the poll ended

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelPredictionData#

Bases: TwitchObject

id: str#: Channel Points Prediction ID.

broadcaster_user_id: str#: The requested broadcaster ID.

broadcaster_user_login: str#: The requested broadcaster login.

broadcaster_user_name: str#: The requested broadcaster display name.

title: str#: Title for the Channel Points Prediction.

outcomes: List[Outcome]#: An array of outcomes for the Channel Points Prediction.

started_at: datetime#: The time the Channel Points Prediction started.

locks_at: datetime#: The time the Channel Points Prediction will automatically lock.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.Outcome#

Bases: TwitchObject

id: str#: The outcome ID.

title: str#: The outcome title.

color: str#: The color for the outcome. Valid values are pink and blue.

users: int#: The number of users who used Channel Points on this outcome.

channel_points: int#: The total number of Channel Points used on this outcome.

top_predictors: TopPredictors#: An array of users who used the most Channel Points on this outcome.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.TopPredictors#

Bases: TwitchObject

user_id: str#: The ID of the user.

user_login: str#: The login of the user.

user_name: str#: The display name of the user.

channel_points_won: int#: The number of Channel Points won. This value is always null in the event payload for Prediction progress and Prediction lock. This value is 0 if the outcome did not win or if the Prediction was canceled and Channel Points were refunded.

channel_points_used: int#: The number of Channel Points used to participate in the Prediction.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ChannelPredictionEndData#

Bases: TwitchObject

id: str#: Channel Points Prediction ID.

broadcaster_user_id: str#: The requested broadcaster ID.

broadcaster_user_login: str#: The requested broadcaster login.

broadcaster_user_name: str#: The requested broadcaster display name.

title: str#: Title for the Channel Points Prediction.

winning_outcome_id: str#: ID of the winning outcome.

outcomes: List[Outcome]#: An array of outcomes for the Channel Points Prediction. Includes top_predictors.

status: str#: The status of the Channel Points Prediction. Valid values are resolved and canceled.

started_at: datetime#: The time the Channel Points Prediction started.

ended_at: datetime#: The time the Channel Points Prediction ended.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.DropEntitlementGrantData#

Bases: TwitchObject

id: str#: Individual event ID, as assigned by EventSub. Use this for de-duplicating messages.

data: Entitlement#: Entitlement object

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.Entitlement#

Bases: TwitchObject

organization_id: str#: The ID of the organization that owns the game that has Drops enabled.

category_id: str#: Twitch category ID of the game that was being played when this benefit was entitled.

category_name: str#: The category name.

campaign_id: str#: The campaign this entitlement is associated with.

user_id: str#: Twitch user ID of the user who was granted the entitlement.

user_name: str#: The user display name of the user who was granted the entitlement.

user_login: str#: The user login of the user who was granted the entitlement.

entitlement_id: str#: Unique identifier of the entitlement. Use this to de-duplicate entitlements.

benefit_id: str#: Identifier of the Benefit.

created_at: datetime#: UTC timestamp in ISO format when this entitlement was granted on Twitch.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.Product#

Bases: TwitchObject

name: str#: Product name.

bits: int#: Bits involved in the transaction.

sku: str#: Unique identifier for the product acquired.

in_development: bool#: Flag indicating if the product is in development. If in_development is true, bits will be 0.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ExtensionBitsTransactionCreateData#

Bases: TwitchObject

extension_client_id: str#: Client ID of the extension.

id: str#: Transaction ID.

broadcaster_user_id: str#: The transaction’s broadcaster ID.

broadcaster_user_login: str#: The transaction’s broadcaster login.

broadcaster_user_name: str#: The transaction’s broadcaster display name.

user_id: str#: The transaction’s user ID.

user_login: str#: The transaction’s user login.

user_name: str#: The transaction’s user display name.

product: Product#: Additional extension product information.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.GoalData#

Bases: TwitchObject

id: str#: An ID that identifies this event.

broadcaster_user_id: str#: An ID that uniquely identifies the broadcaster.

broadcaster_user_name: str#: The broadcaster’s display name.

broadcaster_user_login: str#: The broadcaster’s user handle.

type: str#

The type of goal. Possible values are:

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).

description: str#: A description of the goal, if specified. The description may contain a maximum of 40 characters.

is_achieved: Optional[bool]#: A Boolean value that indicates whether the broadcaster achieved their goal. Is true if the goal was achieved; otherwise, false. Only the channel.goal.end event includes this field.

current_amount: int#

The goals current value. The goals type determines how this value is increased or decreased

If type is follow, this field is set to the broadcaster’s current number of followers. This number increases with new followers and decreases when users unfollow the broadcaster.
If type is subscription, this field 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.
If type is subscription_count, this field is increased by 1 for each new subscription and decreased by 1 for each user that unsubscribes.
If type is 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.
If type is new_subscription_count, this field is increased by 1 for each new subscription.

target_amount: int#: 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.

started_at: datetime#: The timestamp which indicates when the broadcaster created the goal.

ended_at: Optional[datetime]#: The timestamp which indicates when the broadcaster ended the goal. Only the channel.goal.end event includes this field.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.TopContribution#

Bases: TwitchObject

user_id: str#: The ID of the user that made the contribution.

user_login: str#: The user’s login name.

user_name: str#: The user’s display name.

type: str#

The contribution method used. Possible values are:

bits — Cheering with Bits.
subscription — Subscription activity like subscribing or gifting subscriptions.
other — Covers other contribution methods not listed.

total: int#: The total amount contributed. If type is bits, total represents the amount of Bits used. If type is subscription, total is 500, 1000, or 2500 to represent tier 1, 2, or 3 subscriptions, respectively.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.LastContribution#

Bases: TwitchObject

user_id: str#: The ID of the user that made the contribution.

user_login: str#: The user’s login name.

user_name: str#: The user’s display name.

type: str#

The contribution method used. Possible values are:

bits — Cheering with Bits.
subscription — Subscription activity like subscribing or gifting subscriptions.
other — Covers other contribution methods not listed.

total: int#: The total amount contributed. If type is bits, total represents the amount of Bits used. If type is subscription, total is 500, 1000, or 2500 to represent tier 1, 2, or 3 subscriptions, respectively.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.HypeTrainData#

Bases: TwitchObject

id: str#: The Hype Train ID.

broadcaster_user_id: str#: The requested broadcaster ID.

broadcaster_user_login: str#: The requested broadcaster login.

broadcaster_user_name: str#: The requested broadcaster display name.

total: int#: Total points contributed to the Hype Train.

progress: int#: The number of points contributed to the Hype Train at the current level.

goal: int#: The number of points required to reach the next level.

top_contributions: List[TopContribution]#: The contributors with the most points contributed.

last_contribution: LastContribution#: The most recent contribution.

level: int#: The starting level of the Hype Train.

started_at: datetime#: The time when the Hype Train started.

expires_at: datetime#: The time when the Hype Train expires. The expiration is extended when the Hype Train reaches a new level.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.HypeTrainEndData#

Bases: TwitchObject

id: str#: The Hype Train ID.

broadcaster_user_id: str#: The requested broadcaster ID.

broadcaster_user_login: str#: The requested broadcaster login.

broadcaster_user_name: str#: The requested broadcaster display name.

level: int#: The final level of the Hype Train.

total: int#: Total points contributed to the Hype Train.

top_contributions: List[TopContribution]#: The contributors with the most points contributed.

started_at: datetime#: The time when the Hype Train started.

ended_at: datetime#: The time when the Hype Train ended.

cooldown_ends_at: datetime#: The time when the Hype Train cooldown ends so that the next Hype Train can start.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.StreamOnlineData#

Bases: TwitchObject

id: str#: The id of the stream.

broadcaster_user_id: str#: The broadcaster’s user id.

broadcaster_user_login: str#: The broadcaster’s user login.

broadcaster_user_name: str#: The broadcaster’s user display name.

type: str#: The stream type. Valid values are: live, playlist, watch_party, premiere, rerun.

started_at: datetime#: The timestamp at which the stream went online at.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.StreamOfflineData#

Bases: TwitchObject

broadcaster_user_id: str#: The broadcaster’s user id.

broadcaster_user_login: str#: The broadcaster’s user login.

broadcaster_user_name: str#: The broadcaster’s user display name.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.UserAuthorizationGrantData#

Bases: TwitchObject

client_id: str#: The client_id of the application that was granted user access.

user_id: str#: The user id for the user who has granted authorization for your client id.

user_login: str#: The user login for the user who has granted authorization for your client id.

user_name: str#: The user display name for the user who has granted authorization for your client id.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.UserAuthorizationRevokeData#

Bases: TwitchObject

client_id: str#: The client_id of the application with revoked user access.

user_id: str#: The user id for the user who has revoked authorization for your client id.

user_login: str#: The user login for the user who has revoked authorization for your client id. This is null if the user no longer exists.

user_name: str#: The user display name for the user who has revoked authorization for your client id. This is null if the user no longer exists.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.UserUpdateData#

Bases: TwitchObject

user_id: str#: The user’s user id.

user_login: str#: The user’s user login.

user_name: str#: The user’s user display name.

email: str#: The user’s email address. The event includes the user’s email address only if the app used to request this event type includes the user:read:email scope for the user; otherwise, the field is set to an empty string. See Create EventSub Subscription.

email_verified: bool#

A Boolean value that determines whether Twitch has verified the user’s email address. Is true if Twitch has verified the email address; otherwise, false.

NOTE: Ignore this field if the email field contains an empty string.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.ShieldModeData#

Bases: TwitchObject

broadcaster_user_id: str#: An ID that identifies the broadcaster whose Shield Mode status was updated.

broadcaster_user_login: str#: The broadcaster’s login name.

broadcaster_user_name: str#: The broadcaster’s display name.

moderator_user_id: str#: An ID that identifies the moderator that updated the Shield Mode’s status. If the broadcaster updated the status, this ID will be the same as broadcaster_user_id.

moderator_user_login: str#: The moderator’s login name.

moderator_user_name: str#: The moderator’s display name.

started_at: datetime#: The timestamp of when the moderator activated Shield Mode. The object includes this field only for channel.shield_mode.begin events.

ended_at: datetime#: The timestamp of when the moderator deactivated Shield Mode. The object includes this field only for channel.shield_mode.end events.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.Amount#

Bases: TwitchObject

value: int#: The monetary amount. The amount is specified in the currency’s minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550.

decimal_places: int#

The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:

value / 10^decimal_places

currency: str#: The ISO-4217 three-letter currency code that identifies the type of currency in value.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.CharityCampaignStartData#

Bases: TwitchObject

id: str#: An ID that identifies the charity campaign.

broadcaster_id: str#: An ID that identifies the broadcaster that’s running the campaign.

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

broadcaster_login: str#: The broadcaster’s login name.

broadcaster_name: str#: The broadcaster’s display name.

charity_name: str#: The charity’s name.

charity_description: str#: A description of the charity.

charity_logo: str#: A URL to an image of the charity’s logo. The image’s type is PNG and its size is 100px X 100px.

charity_website: str#: A URL to the charity’s website.

current_amount: Amount#: Contains the current amount of donations that the campaign has received.

target_amount: Amount#: Contains the campaign’s target fundraising goal.

started_at: datetime#: The timestamp of when the broadcaster started the campaign.

class twitchAPI.object.eventsub.CharityCampaignStopData#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

id: str#: An ID that identifies the charity campaign.

broadcaster_id: str#: An ID that identifies the broadcaster that ran the campaign.

broadcaster_login: str#: The broadcaster’s login name.

broadcaster_name: str#: The broadcaster’s display name.

charity_name: str#: The charity’s name.

charity_description: str#: A description of the charity.

charity_logo: str#: A URL to an image of the charity’s logo. The image’s type is PNG and its size is 100px X 100px.

charity_website: str#: A URL to the charity’s website.

current_amount: Amount#: Contains the final amount of donations that the campaign received.

target_amount: Amount#: Contains the campaign’s target fundraising goal.

stopped_at: datetime#: The timestamp of when the broadcaster stopped the campaign.

class twitchAPI.object.eventsub.CharityCampaignProgressData#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

id: str#: An ID that identifies the charity campaign.

broadcaster_id: str#: An ID that identifies the broadcaster that’s running the campaign.

broadcaster_login: str#: The broadcaster’s login name.

broadcaster_name: str#: The broadcaster’s display name.

charity_name: str#: The charity’s name.

charity_description: str#: A description of the charity.

charity_logo: str#: A URL to an image of the charity’s logo. The image’s type is PNG and its size is 100px X 100px.

charity_website: str#: A URL to the charity’s website.

current_amount: Amount#: Contains the current amount of donations that the campaign has received.

target_amount: Amount#: Contains the campaign’s target fundraising goal.

class twitchAPI.object.eventsub.CharityDonationData#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

id: str#: An ID that identifies the donation. The ID is unique across campaigns.

campaign_id: str#: An ID that identifies the charity campaign.

broadcaster_id: str#: An ID that identifies the broadcaster that’s running the campaign.

broadcaster_login: str#: The broadcaster’s login name.

broadcaster_name: str#: The broadcaster’s display name.

user_id: str#: An ID that identifies the user that donated to the campaign.

user_login: str#: The user’s login name.

user_name: str#: The user’s display name.

charity_name: str#: The charity’s name.

charity_description: str#: A description of the charity.

charity_logo: str#: A URL to an image of the charity’s logo. The image’s type is PNG and its size is 100px X 100px.

charity_website: str#: A URL to the charity’s website.

amount: Amount#: Contains the amount of money that the user donated.

class twitchAPI.object.eventsub.ChannelShoutoutCreateData#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

broadcaster_user_id: str#: An ID that identifies the broadcaster that sent the Shoutout.

broadcaster_user_login: str#: The broadcaster’s login name.

broadcaster_user_name: str#: The broadcaster’s display name.

to_broadcaster_user_id: str#: An ID that identifies the broadcaster that received the Shoutout.

to_broadcaster_user_login: str#: The broadcaster’s login name.

to_broadcaster_user_name: str#: The broadcaster’s display name.

moderator_user_id: str#: An ID that identifies the moderator that sent the Shoutout. If the broadcaster sent the Shoutout, this ID is the same as the ID in broadcaster_user_id.

moderator_user_login: str#: The moderator’s login name.

moderator_user_name: str#: The moderator’s display name.

viewer_count: int#: The number of users that were watching the broadcaster’s stream at the time of the Shoutout.

started_at: datetime#: The timestamp of when the moderator sent the Shoutout.

cooldown_ends_at: datetime#: The timestamp of when the broadcaster may send a Shoutout to a different broadcaster.

target_cooldown_ends_at: datetime#: The timestamp of when the broadcaster may send another Shoutout to the broadcaster in to_broadcaster_user_id.

class twitchAPI.object.eventsub.ChannelShoutoutReceiveData#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

broadcaster_user_id: str#: An ID that identifies the broadcaster that received the Shoutout.

broadcaster_user_login: str#: The broadcaster’s login name.

broadcaster_user_name: str#: The broadcaster’s display name.

from_broadcaster_user_id: str#: An ID that identifies the broadcaster that sent the Shoutout.

from_broadcaster_user_login: str#: The broadcaster’s login name.

from_broadcaster_user_name: str#: The broadcaster’s display name.

viewer_count: int#: The number of users that were watching the from-broadcaster’s stream at the time of the Shoutout.

started_at: datetime#: The timestamp of when the moderator sent the Shoutout.

class twitchAPI.object.eventsub.ChannelChatClearData#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

broadcaster_user_id: str#: The broadcaster user ID.

broadcaster_user_name: str#: The broadcaster display name.

broadcaster_user_login: str#: The broadcaster login.

class twitchAPI.object.eventsub.ChannelChatClearUserMessagesData#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

broadcaster_user_id: str#: The broadcaster user ID.

broadcaster_user_name: str#: The broadcaster display name.

broadcaster_user_login: str#: The broadcaster login.

target_user_id: str#: The ID of the user that was banned or put in a timeout. All of their messages are deleted.

target_user_name: str#: The user name of the user that was banned or put in a timeout.

target_user_login: str#: The user login of the user that was banned or put in a timeout.

class twitchAPI.object.eventsub.ChannelChatMessageDeleteData#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

broadcaster_user_id: str#: The broadcaster user ID.

broadcaster_user_name: str#: The broadcaster display name.

broadcaster_user_login: str#: The broadcaster login.

target_user_id: str#: The ID of the user whose message was deleted.

target_user_name: str#: The user name of the user whose message was deleted.

target_user_login: str#: The user login of the user whose message was deleted.

message_id: str#: A UUID that identifies the message that was removed.

class twitchAPI.object.eventsub.Badge#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

set_id: str#: An ID that identifies this set of chat badges. For example, Bits or Subscriber.

id: str#: 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.

info: str#: Contains metadata related to the chat badges in the badges tag. Currently, this tag contains metadata only for subscriber badges, to indicate the number of months the user has been a subscriber.

class twitchAPI.object.eventsub.MessageFragmentCheermote#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

prefix: str#: 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.

bits: int#: The amount of bits cheered.

tier: int#: The tier level of the cheermote.

class twitchAPI.object.eventsub.MessageFragmentEmote#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

id: str#: An ID that uniquely identifies this emote.

emote_set_id: str#: An ID that identifies the emote set that the emote belongs to.

owner_id: str#: The ID of the broadcaster who owns the emote.

format: List[str]#

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.

class twitchAPI.object.eventsub.MessageFragmentMention#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

user_id: str#: The user ID of the mentioned user.

user_name: str#: The user name of the mentioned user.

user_login: str#: The user login of the mentioned user.

class twitchAPI.object.eventsub.MessageFragment#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

type: str#

The type of message fragment. Possible values:

text
cheermote
emote
mention

text: str#: Message text in fragment

cheermote: Optional[MessageFragmentCheermote]#: Metadata pertaining to the cheermote.

emote: Optional[MessageFragmentEmote]#: Metadata pertaining to the emote.

mention: Optional[MessageFragmentMention]#: Metadata pertaining to the mention.

class twitchAPI.object.eventsub.Message#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

text: str#: The chat message in plain text.

fragments: List[MessageFragment]#: Ordered list of chat message fragments.

class twitchAPI.object.eventsub.AnnouncementNoticeMetadata#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

color: str#: Color of the announcement.

class twitchAPI.object.eventsub.CharityDonationNoticeMetadata#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

charity_name: str#: Name of the charity.

amount: Amount#: An object that contains the amount of money that the user paid.

class twitchAPI.object.eventsub.BitsBadgeTierNoticeMetadata#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

tier: int#: The tier of the Bits badge the user just earned. For example, 100, 1000, or 10000.

class twitchAPI.object.eventsub.SubNoticeMetadata#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

sub_tier: str#

The type of subscription plan being used. Possible values are:

1000 — First level of paid or Prime subscription
2000 — Second level of paid subscription
3000 — Third level of paid subscription

is_prime: bool#: Indicates if the subscription was obtained through Amazon Prime.

duration_months: int#: The number of months the subscription is for.

class twitchAPI.object.eventsub.RaidNoticeMetadata#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

user_id: str#: The user ID of the broadcaster raiding this channel.

user_name: str#: The user name of the broadcaster raiding this channel.

user_login: str#: The login name of the broadcaster raiding this channel.

viewer_count: int#: The number of viewers raiding this channel from the broadcaster’s channel.

profile_image_url: str#: Profile image URL of the broadcaster raiding this channel.

class twitchAPI.object.eventsub.ResubNoticeMetadata#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

cumulative_months: int#: The total number of months the user has subscribed.

duration_months: int#: The number of months the subscription is for.

streak_months: int#: Optional. The number of consecutive months the user has subscribed.

sub_tier: str#

The type of subscription plan being used. Possible values are:

1000 — First level of paid or Prime subscription
2000 — Second level of paid subscription
3000 — Third level of paid subscription

is_prime: bool#: Indicates if the resub was obtained through Amazon Prime.

is_gift: bool#: Whether or not the resub was a result of a gift.

gifter_is_anonymous: Optional[bool]#: Optional. Whether or not the gift was anonymous.

gifter_user_id: Optional[str]#: Optional. The user ID of the subscription gifter. None if anonymous.

gifter_user_name: Optional[str]#: Optional. The user name of the subscription gifter. None if anonymous.

gifter_user_login: Optional[str]#: Optional. The user login of the subscription gifter. None if anonymous.

class twitchAPI.object.eventsub.UnraidNoticeMetadata#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

class twitchAPI.object.eventsub.SubGiftNoticeMetadata#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

duration_months: int#: The number of months the subscription is for.

cumulative_total: Optional[int]#: Optional. The amount of gifts the gifter has given in this channel. None if anonymous.

recipient_user_id: str#: The user ID of the subscription gift recipient.

recipient_user_name: str#: The user name of the subscription gift recipient.

recipient_user_login: str#: The user login of the subscription gift recipient.

sub_tier: str#

The type of subscription plan being used. Possible values are:

1000 — First level of paid subscription
2000 — Second level of paid subscription
3000 — Third level of paid subscription

community_gift_id: Optional[str]#: Optional. The ID of the associated community gift. None if not associated with a community gift.

class twitchAPI.object.eventsub.CommunitySubGiftNoticeMetadata#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

id: str#: The ID of the associated community gift.

total: int#: Number of subscriptions being gifted.

sub_tier: str#

The type of subscription plan being used. Possible values are:

1000 — First level of paid subscription
2000 — Second level of paid subscription
3000 — Third level of paid subscription

cumulative_total: Optional[int]#: Optional. The amount of gifts the gifter has given in this channel. None if anonymous.

class twitchAPI.object.eventsub.GiftPaidUpgradeNoticeMetadata#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

gifter_is_anonymous: bool#: Whether the gift was given anonymously.

gifter_user_id: Optional[str]#: Optional. The user ID of the user who gifted the subscription. None if anonymous.

gifter_user_name: Optional[str]#: Optional. The user name of the user who gifted the subscription. None if anonymous.

gifter_user_login: Optional[str]#: Optional. The user login of the user who gifted the subscription. None if anonymous.

class twitchAPI.object.eventsub.PrimePaidUpgradeNoticeMetadata#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

sub_tier: str#

The type of subscription plan being used. Possible values are:

1000 — First level of paid subscription
2000 — Second level of paid subscription
3000 — Third level of paid subscription

class twitchAPI.object.eventsub.PayItForwardNoticeMetadata#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

gifter_is_anonymous: bool#: Whether the gift was given anonymously.

gifter_user_id: Optional[str]#: Optional. The user ID of the user who gifted the subscription. None if anonymous.

gifter_user_name: Optional[str]#: Optional. The user name of the user who gifted the subscription. None if anonymous.

gifter_user_login: Optional[str]#: Optional. The user login of the user who gifted the subscription. None if anonymous.

class twitchAPI.object.eventsub.ChannelChatNotificationData#

Bases: TwitchObject

__init__(**kwargs)#

to_dict(include_none_values=False)#

build dict based on annotation types

Parameters:: include_none_values¶ (bool) – if fields that have None values should be included in the dictionary
Return type:: dict

broadcaster_user_id: str#: The broadcaster user ID.

broadcaster_user_name: str#: The broadcaster display name.

broadcaster_user_login: str#: The broadcaster login.

chatter_user_id: str#: The user ID of the user that sent the message.

chatter_user_name: str#: The user name of the user that sent the message.

chatter_user_login: str#: The user login of the user that sent the message.

chatter_is_anonymous: bool#: Whether or not the chatter is anonymous.

color: str#: The color of the user’s name in the chat room.

badges: List[Badge]#: List of chat badges.

system_message: str#: The message Twitch shows in the chat room for this notice.

message_id: str#: A UUID that identifies the message.

message: Message#: The structured chat message

notice_type: str#

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

sub: Optional[SubNoticeMetadata]#: Information about the sub event. None if notice_type is not sub.

resub: Optional[ResubNoticeMetadata]#: Information about the resub event. None if notice_type is not resub.

sub_gift: Optional[SubGiftNoticeMetadata]#: Information about the gift sub event. None if notice_type is not sub_gift.

community_sub_gift: Optional[CommunitySubGiftNoticeMetadata]#: Information about the community gift sub event. None if notice_type is not community_sub_gift.

gift_paid_upgrade: Optional[GiftPaidUpgradeNoticeMetadata]#: Information about the community gift paid upgrade event. None if notice_type is not gift_paid_upgrade.

prime_paid_upgrade: Optional[PrimePaidUpgradeNoticeMetadata]#: Information about the Prime gift paid upgrade event. None if notice_type is not prime_paid_upgrade.

raid: Optional[RaidNoticeMetadata]#: Information about the raid event. None if notice_type is not raid.

unraid: Optional[UnraidNoticeMetadata]#: Returns an empty payload if notice_type is unraid, otherwise returns None.

pay_it_forward: Optional[PayItForwardNoticeMetadata]#: Information about the pay it forward event. None if notice_type is not pay_it_forward.

announcement: Optional[AnnouncementNoticeMetadata]#: Information about the announcement event. None if notice_type is not announcement

charity_donation: Optional[CharityDonationNoticeMetadata]#: Information about the charity donation event. None if notice_type is not charity_donation.

bits_badge_tier: Optional[BitsBadgeTierNoticeMetadata]#: Information about the bits badge tier event. None if notice_type is not bits_badge_tier.