Objects used by the Twitch API#
- class twitchAPI.object.api.TwitchUser#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.TwitchUserFollow#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.TwitchUserFollowResult#
Bases:
AsyncIterTwitchObject
[TwitchUserFollow
]-
data:
List
[TwitchUserFollow
]#
- __init__(_data, **kwargs)#
-
data:
- class twitchAPI.object.api.DateRange#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.ExtensionAnalytic#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.GameAnalytics#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.CreatorGoal#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.BitsLeaderboardEntry#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.BitsLeaderboard#
Bases:
IterTwitchObject
-
data:
List
[BitsLeaderboardEntry
]#
- __init__(**kwargs)#
-
data:
- class twitchAPI.object.api.ProductCost#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.ProductData#
Bases:
TwitchObject
-
cost:
ProductCost
#
- __init__(**kwargs)#
-
cost:
- class twitchAPI.object.api.ExtensionTransaction#
Bases:
TwitchObject
-
product_data:
ProductData
#
- __init__(**kwargs)#
-
product_data:
- class twitchAPI.object.api.ChatSettings#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.CreatedClip#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.Clip#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.CodeStatus#
Bases:
TwitchObject
-
status:
StatusCode
#
- __init__(**kwargs)#
-
status:
- class twitchAPI.object.api.Game#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.AutoModStatus#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.BannedUser#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.BanUserResponse#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.BlockedTerm#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.Moderator#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.CreateStreamMarkerResponse#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.Stream#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.StreamMarker#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.StreamMarkers#
Bases:
TwitchObject
-
markers:
List
[StreamMarker
]#
- __init__(**kwargs)#
-
markers:
- class twitchAPI.object.api.GetStreamMarkerResponse#
Bases:
TwitchObject
-
videos:
List
[StreamMarkers
]#
- __init__(**kwargs)#
-
videos:
- class twitchAPI.object.api.BroadcasterSubscription#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.BroadcasterSubscriptions#
Bases:
AsyncIterTwitchObject
[BroadcasterSubscription
]-
data:
List
[BroadcasterSubscription
]#
- __init__(_data, **kwargs)#
-
data:
- class twitchAPI.object.api.UserSubscription#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.StreamTag#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.TeamUser#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.ChannelTeam#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.UserExtension#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.ActiveUserExtension#
Bases:
UserExtension
- __init__(**kwargs)#
- to_dict(include_none_values=False)#
build dict based on annotation types
- class twitchAPI.object.api.UserActiveExtensions#
Bases:
TwitchObject
-
panel:
Dict
[str
,ActiveUserExtension
]#
-
overlay:
Dict
[str
,ActiveUserExtension
]#
-
component:
Dict
[str
,ActiveUserExtension
]#
- __init__(**kwargs)#
-
panel:
- class twitchAPI.object.api.VideoMutedSegments#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.Video#
Bases:
TwitchObject
-
muted_segments:
List
[VideoMutedSegments
]#
- __init__(**kwargs)#
-
muted_segments:
- class twitchAPI.object.api.ChannelInformation#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.SearchChannelResult#
Bases:
TwitchObject
-
broadcaster_language:
str
# The ISO 639-1 two-letter language code of the language used by the broadcaster. For example, en for English. If the broadcaster uses a language not in the list of supported stream languages, the value is other.
-
is_live:
bool
# A Boolean value that determines whether the broadcaster is streaming live. Is True if the broadcaster is streaming live; otherwise, False.
-
started_at:
Optional
[datetime
]# The datetime of when the broadcaster started streaming. None if the broadcaster is not streaming live.
- __init__(**kwargs)#
-
broadcaster_language:
- class twitchAPI.object.api.SearchCategoryResult#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.StartCommercialResult#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.Cheermote#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.GetCheermotesResponse#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.HypeTrainContribution#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.HypeTrainEventData#
Bases:
TwitchObject
-
last_contribution:
HypeTrainContribution
#
-
top_contributions:
List
[HypeTrainContribution
]#
- __init__(**kwargs)#
-
last_contribution:
- class twitchAPI.object.api.HypeTrainEvent#
Bases:
TwitchObject
-
event_data:
HypeTrainEventData
#
- __init__(**kwargs)#
-
event_data:
- class twitchAPI.object.api.DropsEntitlement#
Bases:
TwitchObject
-
fulfillment_status:
DropsEntitlementFulfillmentStatus
#
- __init__(**kwargs)#
-
fulfillment_status:
- class twitchAPI.object.api.MaxPerStreamSetting#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.MaxPerUserPerStreamSetting#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.GlobalCooldownSetting#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.CustomReward#
Bases:
TwitchObject
-
max_per_stream_setting:
MaxPerStreamSetting
#
-
max_per_user_per_stream_setting:
MaxPerUserPerStreamSetting
#
-
global_cooldown_setting:
GlobalCooldownSetting
#
- __init__(**kwargs)#
-
max_per_stream_setting:
- class twitchAPI.object.api.PartialCustomReward#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.CustomRewardRedemption#
Bases:
TwitchObject
-
status:
CustomRewardRedemptionStatus
#
-
reward:
PartialCustomReward
#
- __init__(**kwargs)#
-
status:
- class twitchAPI.object.api.ChannelEditor#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.BlockListEntry#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.PollChoice#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.Poll#
Bases:
TwitchObject
-
choices:
List
[PollChoice
]#
-
status:
PollStatus
#
- __init__(**kwargs)#
-
choices:
- class twitchAPI.object.api.Predictor#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.PredictionOutcome#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.Prediction#
Bases:
TwitchObject
-
outcomes:
List
[PredictionOutcome
]#
-
status:
PredictionStatus
#
- __init__(**kwargs)#
-
outcomes:
- class twitchAPI.object.api.RaidStartResult#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.ChatBadgeVersion#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.ChatBadge#
Bases:
TwitchObject
-
versions:
List
[ChatBadgeVersion
]#
- __init__(**kwargs)#
-
versions:
- class twitchAPI.object.api.Emote#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.ChannelEmote#
Bases:
Emote
- __init__(**kwargs)#
- to_dict(include_none_values=False)#
build dict based on annotation types
- class twitchAPI.object.api.UserEmote#
Bases:
Emote
- __init__(**kwargs)#
- to_dict(include_none_values=False)#
build dict based on annotation types
- class twitchAPI.object.api.GetChannelEmotesResponse#
Bases:
IterTwitchObject
-
data:
List
[ChannelEmote
]#
- __init__(**kwargs)#
-
data:
- class twitchAPI.object.api.GetEmotesResponse#
Bases:
IterTwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.EventSubSubscription#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.GetEventSubSubscriptionResult#
Bases:
AsyncIterTwitchObject
[EventSubSubscription
]-
data:
List
[EventSubSubscription
]#
- __init__(_data, **kwargs)#
-
data:
- class twitchAPI.object.api.StreamCategory#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.ChannelStreamScheduleSegment#
Bases:
TwitchObject
-
category:
StreamCategory
#
- __init__(**kwargs)#
-
category:
- class twitchAPI.object.api.StreamVacation#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.ChannelStreamSchedule#
Bases:
AsyncIterTwitchObject
[ChannelStreamScheduleSegment
]-
segments:
List
[ChannelStreamScheduleSegment
]#
-
vacation:
Optional
[StreamVacation
]#
- __init__(_data, **kwargs)#
-
segments:
- class twitchAPI.object.api.ChannelVIP#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.UserChatColor#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.Chatter#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.GetChattersResponse#
Bases:
AsyncIterTwitchObject
[Chatter
]- __init__(_data, **kwargs)#
- class twitchAPI.object.api.ShieldModeStatus#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.CharityAmount#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.CharityCampaign#
Bases:
TwitchObject
-
current_amount:
CharityAmount
#
-
target_amount:
CharityAmount
#
- __init__(**kwargs)#
-
current_amount:
- class twitchAPI.object.api.CharityCampaignDonation#
Bases:
TwitchObject
-
amount:
CharityAmount
#
- __init__(**kwargs)#
-
amount:
- class twitchAPI.object.api.AutoModSettings#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.ChannelFollower#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.ChannelFollowersResult#
Bases:
AsyncIterTwitchObject
[ChannelFollower
]-
data:
List
[ChannelFollower
]#
- __init__(_data, **kwargs)#
-
data:
- class twitchAPI.object.api.FollowedChannel#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.FollowedChannelsResult#
Bases:
AsyncIterTwitchObject
[FollowedChannel
]-
data:
List
[FollowedChannel
]#
- __init__(_data, **kwargs)#
-
data:
- class twitchAPI.object.api.ContentClassificationLabel#
Bases:
TwitchObject
- __init__(**kwargs)#
- class twitchAPI.object.api.AdSchedule#
Bases:
TwitchObject
-
snooze_refresh_at:
Optional
[datetime
]# The UTC timestamp when the broadcaster will gain an additional snooze.
-
next_ad_at:
Optional
[datetime
]# The UTC timestamp of the broadcaster’s next scheduled ad. Empty if the channel has no ad scheduled or is not live.
-
last_ad_at:
Optional
[datetime
]# The UTC timestamp of the broadcaster’s last ad-break. Empty if the channel has not run an ad or is not live.
-
preroll_free_time:
int
# The amount of pre-roll free time remaining for the channel in seconds. Returns 0 if they are currently not pre-roll free.
- __init__(**kwargs)#
-
snooze_refresh_at:
- class twitchAPI.object.api.AdSnoozeResponse#
Bases:
TwitchObject
-
snooze_refresh_at:
Optional
[datetime
]# The UTC timestamp when the broadcaster will gain an additional snooze
- __init__(**kwargs)#
-
snooze_refresh_at:
- class twitchAPI.object.api.SendMessageResponse#
Bases:
TwitchObject
- __init__(**kwargs)#
- to_dict(include_none_values=False)#
build dict based on annotation types
- class twitchAPI.object.api.ChannelModerator#
Bases:
TwitchObject
- __init__(**kwargs)#
- to_dict(include_none_values=False)#
build dict based on annotation types
- class twitchAPI.object.api.UserEmotesResponse#
Bases:
AsyncIterTwitchObject
- __init__(_data, **kwargs)#
- to_dict(include_none_values=False)#
build dict based on annotation types
- class twitchAPI.object.api.WarnResponse#
Bases:
TwitchObject
- __init__(**kwargs)#
- to_dict(include_none_values=False)#
build dict based on annotation types
Bases:
TwitchObject
build dict based on annotation types
The User ID of the participant channel.
Bases:
TwitchObject
build dict based on annotation types
The unique identifier for the shared chat session.
The User ID of the host channel.
The list of participants in the session.
The UTC timestamp when the session was created.
The UTC timestamp when the session was last updated.