Objects used by the Twitch API#

class twitchAPI.object.api.TwitchUser#

Bases: TwitchObject

id: str#
login: str#
display_name: str#
type: str#
broadcaster_type: str#
description: str#
profile_image_url: str#
offline_image_url: str#
view_count: int#
email: str = None#
created_at: datetime#
__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.api.TwitchUserFollow#

Bases: TwitchObject

from_id: str#
from_login: str#
from_name: str#
to_id: str#
to_login: str#
to_name: str#
followed_at: datetime#
__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.api.TwitchUserFollowResult#

Bases: AsyncIterTwitchObject[TwitchUserFollow]

total: int#
data: List[TwitchUserFollow]#
__init__(_data, **kwargs)#
static __new__(cls, *args, **kwds)#
current_cursor()#

Provides the currently used forward pagination cursor

Return type:

Optional[str]

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.api.DateRange#

Bases: TwitchObject

ended_at: datetime#
started_at: datetime#
__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.api.ExtensionAnalytic#

Bases: TwitchObject

extension_id: str#
URL: str#
type: str#
date_range: DateRange#
__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.api.GameAnalytics#

Bases: TwitchObject

game_id: str#
URL: str#
type: str#
date_range: DateRange#
__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.api.CreatorGoal#

Bases: TwitchObject

id: str#
broadcaster_id: str#
broadcaster_name: str#
broadcaster_login: str#
type: str#
description: str#
current_amount: int#
target_amount: int#
created_at: datetime#
__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.api.BitsLeaderboardEntry#

Bases: TwitchObject

user_id: str#
user_login: str#
user_name: str#
rank: int#
score: int#
__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.api.BitsLeaderboard#

Bases: IterTwitchObject

data: List[BitsLeaderboardEntry]#
date_range: DateRange#
total: int#
__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.api.ProductCost#

Bases: TwitchObject

amount: int#
type: 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.api.ProductData#

Bases: TwitchObject

domain: str#
sku: str#
cost: ProductCost#
__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.api.ExtensionTransaction#

Bases: TwitchObject

id: str#
timestamp: datetime#
broadcaster_id: str#
broadcaster_login: str#
broadcaster_name: str#
user_id: str#
user_login: str#
user_name: str#
product_type: str#
product_data: ProductData#
inDevelopment: bool#
displayName: str#
expiration: str#
broadcast: 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.api.ChatSettings#

Bases: TwitchObject

broadcaster_id: str#
moderator_id: str#
emote_mode: bool#
slow_mode: bool#
slow_mode_wait_time: int#
follower_mode: bool#
follower_mode_duration: int#
subscriber_mode: bool#
unique_chat_mode: bool#
non_moderator_chat_delay: bool#
non_moderator_chat_delay_duration: int#
__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.api.CreatedClip#

Bases: TwitchObject

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

Bases: TwitchObject

id: str#
url: str#
embed_url: str#
broadcaster_id: str#
broadcaster_name: str#
creator_id: str#
creator_name: str#
video_id: str#
game_id: str#
language: str#
title: str#
view_count: int#
created_at: datetime#
thumbnail_url: str#
duration: float#
vod_offset: int#
__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.api.CodeStatus#

Bases: TwitchObject

code: str#
status: StatusCode#
__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.api.Game#

Bases: TwitchObject

box_art_url: str#
id: str#
name: str#
igdb_id: 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.api.AutoModStatus#

Bases: TwitchObject

msg_id: str#
is_permitted: bool#
__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.api.BannedUser#

Bases: TwitchObject

user_id: str#
user_login: str#
user_name: str#
expires_at: datetime#
created_at: datetime#
reason: str#
moderator_id: str#
moderator_login: str#
moderator_name: 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.api.BanUserResponse#

Bases: TwitchObject

broadcaster_id: str#
moderator_id: str#
user_id: str#
created_at: datetime#
end_time: datetime#
__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.api.BlockedTerm#

Bases: TwitchObject

broadcaster_id: str#
moderator_id: str#
id: str#
text: str#
created_at: datetime#
updated_at: datetime#
expires_at: datetime#
__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.api.Moderator#

Bases: TwitchObject

user_id: str#
user_login: str#
user_name: 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.api.CreateStreamMarkerResponse#

Bases: TwitchObject

id: str#
created_at: datetime#
description: str#
position_seconds: int#
__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.api.Stream#

Bases: TwitchObject

id: str#
user_id: str#
user_login: str#
user_name: str#
game_id: str#
game_name: str#
type: str#
title: str#
viewer_count: int#
started_at: datetime#
language: str#
thumbnail_url: str#
tag_ids: List[str]#
is_mature: bool#
tags: List[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.api.StreamMarker#

Bases: TwitchObject

id: str#
created_at: datetime#
description: str#
position_seconds: int#
URL: 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.api.StreamMarkers#

Bases: TwitchObject

video_id: str#
markers: List[StreamMarker]#
__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.api.GetStreamMarkerResponse#

Bases: TwitchObject

user_id: str#
user_name: str#
user_login: str#
videos: List[StreamMarkers]#
__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.api.BroadcasterSubscription#

Bases: TwitchObject

broadcaster_id: str#
broadcaster_login: str#
broadcaster_name: str#
gifter_id: str#
gifter_login: str#
gifter_name: str#
is_gift: bool#
tier: str#
plan_name: str#
user_id: str#
user_name: str#
user_login: 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.api.BroadcasterSubscriptions#

Bases: AsyncIterTwitchObject[BroadcasterSubscription]

total: int#
points: int#
data: List[BroadcasterSubscription]#
__init__(_data, **kwargs)#
static __new__(cls, *args, **kwds)#
current_cursor()#

Provides the currently used forward pagination cursor

Return type:

Optional[str]

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.api.UserSubscription#

Bases: TwitchObject

broadcaster_id: str#
broadcaster_name: str#
broadcaster_login: str#
is_gift: bool#
tier: 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.api.StreamTag#

Bases: TwitchObject

tag_id: str#
is_auto: bool#
localization_names: Dict[str, str]#
localization_descriptions: Dict[str, 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.api.TeamUser#

Bases: TwitchObject

user_id: str#
user_name: str#
user_login: 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.api.ChannelTeam#

Bases: TwitchObject

broadcaster_id: str#
broadcaster_name: str#
broadcaster_login: str#
background_image_url: str#
banner: str#
users: Optional[List[TeamUser]]#
created_at: datetime#
updated_at: datetime#
info: str#
thumbnail_url: str#
team_name: str#
team_display_name: str#
id: 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.api.UserExtension#

Bases: TwitchObject

id: str#
version: str#
can_activate: bool#
type: List[str]#
name: 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.api.ActiveUserExtension#

Bases: UserExtension

x: int#
y: int#
active: bool#
__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#
version: str#
can_activate: bool#
type: List[str]#
name: str#
class twitchAPI.object.api.UserActiveExtensions#

Bases: TwitchObject

panel: Dict[str, ActiveUserExtension]#
overlay: Dict[str, ActiveUserExtension]#
component: Dict[str, ActiveUserExtension]#
__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.api.VideoMutedSegments#

Bases: TwitchObject

duration: int#
offset: int#
__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.api.Video#

Bases: TwitchObject

id: str#
stream_id: str#
user_id: str#
user_login: str#
user_name: str#
title: str#
description: str#
created_at: datetime#
published_at: datetime#
url: str#
thumbnail_url: str#
viewable: str#
view_count: int#
language: str#
type: VideoType#
duration: str#
muted_segments: List[VideoMutedSegments]#
__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.api.ChannelInformation#

Bases: TwitchObject

broadcaster_id: str#
broadcaster_login: str#
broadcaster_name: str#
game_name: str#
game_id: str#
broadcaster_language: str#
title: str#
delay: int#
tags: List[str]#
content_classification_labels: List[str]#
is_branded_content: bool#
__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.api.SearchChannelResult#

Bases: ChannelInformation

is_live: bool#
tags_ids: List[str]#
started_at: datetime#
__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_id: str#
broadcaster_login: str#
broadcaster_name: str#
game_name: str#
game_id: str#
broadcaster_language: str#
title: str#
delay: int#
tags: List[str]#
content_classification_labels: List[str]#
is_branded_content: bool#
class twitchAPI.object.api.SearchCategoryResult#

Bases: TwitchObject

id: str#
name: str#
box_art_url: 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.api.StartCommercialResult#

Bases: TwitchObject

length: int#
message: str#
retry_after: int#
__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.api.Cheermote#

Bases: TwitchObject

min_bits: int#
id: str#
color: str#
images: Dict[str, Dict[str, Dict[str, str]]]#
can_cheer: bool#
show_in_bits_card: bool#
__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.api.GetCheermotesResponse#

Bases: TwitchObject

prefix: str#
tiers: List[Cheermote]#
type: str#
order: int#
last_updated: datetime#
is_charitable: bool#
__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.api.HypeTrainContribution#

Bases: TwitchObject

total: int#
type: HypeTrainContributionMethod#
user: 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.api.HypeTrainEventData#

Bases: TwitchObject

broadcaster_id: str#
cooldown_end_time: datetime#
expires_at: datetime#
goal: int#
id: str#
last_contribution: HypeTrainContribution#
level: int#
started_at: datetime#
top_contributions: List[HypeTrainContribution]#
total: int#
__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.api.HypeTrainEvent#

Bases: TwitchObject

id: str#
event_type: str#
event_timestamp: datetime#
version: str#
event_data: HypeTrainEventData#
__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.api.DropsEntitlement#

Bases: TwitchObject

id: str#
benefit_id: str#
timestamp: datetime#
user_id: str#
game_id: str#
fulfillment_status: DropsEntitlementFulfillmentStatus#
updated_at: datetime#
__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.api.MaxPerStreamSetting#

Bases: TwitchObject

is_enabled: bool#
max_per_stream: int#
__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.api.MaxPerUserPerStreamSetting#

Bases: TwitchObject

is_enabled: bool#
max_per_user_per_stream: int#
__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.api.GlobalCooldownSetting#

Bases: TwitchObject

is_enabled: bool#
global_cooldown_seconds: int#
__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.api.CustomReward#

Bases: TwitchObject

broadcaster_name: str#
broadcaster_login: str#
broadcaster_id: str#
id: str#
image: str#
background_color: str#
is_enabled: bool#
cost: int#
title: str#
prompt: str#
is_user_input_required: bool#
max_per_stream_setting: MaxPerStreamSetting#
max_per_user_per_stream_setting: MaxPerUserPerStreamSetting#
global_cooldown_setting: GlobalCooldownSetting#
is_paused: bool#
is_in_stock: bool#
default_image: Dict[str, str]#
should_redemptions_skip_request_queue: bool#
redemptions_redeemed_current_stream: int#
cooldown_expires_at: datetime#
__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.api.PartialCustomReward#

Bases: TwitchObject

id: str#
title: str#
prompt: str#
cost: int#
__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.api.CustomRewardRedemption#

Bases: TwitchObject

broadcaster_name: str#
broadcaster_login: str#
broadcaster_id: str#
id: str#
user_id: str#
user_name: str#
user_input: str#
status: CustomRewardRedemptionStatus#
redeemed_at: datetime#
reward: PartialCustomReward#
__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.api.ChannelEditor#

Bases: TwitchObject

user_id: str#
user_name: str#
created_at: datetime#
__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.api.BlockListEntry#

Bases: TwitchObject

user_id: str#
user_login: str#
user_name: 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.api.PollChoice#

Bases: TwitchObject

id: str#
title: str#
votes: int#
channel_point_votes: int#
__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.api.Poll#

Bases: TwitchObject

id: str#
broadcaster_name: str#
broadcaster_id: str#
broadcaster_login: str#
title: str#
choices: List[PollChoice]#
channel_point_voting_enabled: bool#
channel_points_per_vote: int#
status: PollStatus#
duration: int#
started_at: datetime#
__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.api.Predictor#

Bases: TwitchObject

user_id: str#
user_name: str#
user_login: str#
channel_points_used: int#
channel_points_won: int#
__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.api.PredictionOutcome#

Bases: TwitchObject

id: str#
title: str#
users: int#
channel_points: int#
top_predictors: Optional[List[Predictor]]#
color: 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.api.Prediction#

Bases: TwitchObject

id: str#
broadcaster_id: str#
broadcaster_name: str#
broadcaster_login: str#
title: str#
winning_outcome_id: Optional[str]#
outcomes: List[PredictionOutcome]#
prediction_window: int#
status: PredictionStatus#
created_at: datetime#
ended_at: Optional[datetime]#
locked_at: Optional[datetime]#
__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.api.RaidStartResult#

Bases: TwitchObject

created_at: datetime#
is_mature: bool#
__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.api.ChatBadgeVersion#

Bases: TwitchObject

id: str#
image_url_1x: str#
image_url_2x: str#
image_url_4x: str#
title: str#
description: str#
click_action: Optional[str]#
click_url: Optional[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.api.ChatBadge#

Bases: TwitchObject

set_id: str#
versions: List[ChatBadgeVersion]#
__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.api.Emote#

Bases: TwitchObject

id: str#
name: str#
images: Dict[str, str]#
tier: str#
emote_type: str#
emote_set_id: str#
format: List[str]#
scale: List[str]#
theme_mode: List[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.api.UserEmote#

Bases: Emote

owner_id: 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

id: str#
name: str#
images: Dict[str, str]#
tier: str#
emote_type: str#
emote_set_id: str#
format: List[str]#
scale: List[str]#
theme_mode: List[str]#
class twitchAPI.object.api.GetEmotesResponse#

Bases: IterTwitchObject

data: List[Emote]#
template: 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.api.EventSubSubscription#

Bases: TwitchObject

id: str#
status: str#
type: str#
version: str#
condition: Dict[str, str]#
created_at: datetime#
transport: Dict[str, str]#
cost: int#
__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.api.GetEventSubSubscriptionResult#

Bases: AsyncIterTwitchObject[EventSubSubscription]

total: int#
total_cost: int#
max_total_cost: int#
data: List[EventSubSubscription]#
__init__(_data, **kwargs)#
static __new__(cls, *args, **kwds)#
current_cursor()#

Provides the currently used forward pagination cursor

Return type:

Optional[str]

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.api.StreamCategory#

Bases: TwitchObject

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

Bases: TwitchObject

id: str#
start_time: datetime#
end_time: datetime#
title: str#
canceled_until: Optional[datetime]#
category: StreamCategory#
is_recurring: bool#
__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.api.StreamVacation#

Bases: TwitchObject

start_time: datetime#
end_time: datetime#
__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.api.ChannelStreamSchedule#

Bases: AsyncIterTwitchObject[ChannelStreamScheduleSegment]

segments: List[ChannelStreamScheduleSegment]#
broadcaster_id: str#
broadcaster_name: str#
broadcaster_login: str#
vacation: Optional[StreamVacation]#
__init__(_data, **kwargs)#
static __new__(cls, *args, **kwds)#
current_cursor()#

Provides the currently used forward pagination cursor

Return type:

Optional[str]

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.api.ChannelVIP#

Bases: TwitchObject

user_id: str#
user_name: str#
user_login: 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.api.UserChatColor#

Bases: TwitchObject

user_id: str#
user_name: str#
user_login: str#
color: 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.api.Chatter#

Bases: TwitchObject

user_id: str#
user_login: str#
user_name: 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.api.GetChattersResponse#

Bases: AsyncIterTwitchObject[Chatter]

data: List[Chatter]#
total: int#
__init__(_data, **kwargs)#
static __new__(cls, *args, **kwds)#
current_cursor()#

Provides the currently used forward pagination cursor

Return type:

Optional[str]

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.api.ShieldModeStatus#

Bases: TwitchObject

is_active: bool#
moderator_id: str#
moderator_login: str#
moderator_name: str#
last_activated_at: Optional[datetime]#
__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.api.CharityAmount#

Bases: TwitchObject

value: int#
decimal_places: int#
currency: 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.api.CharityCampaign#

Bases: TwitchObject

id: str#
broadcaster_id: str#
broadcaster_login: str#
broadcaster_name: str#
charity_name: str#
charity_description: str#
charity_website: str#
current_amount: CharityAmount#
target_amount: CharityAmount#
__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.api.CharityCampaignDonation#

Bases: TwitchObject

id: str#
campaign_id: str#
user_id: str#
user_name: str#
user_login: str#
amount: CharityAmount#
__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.api.AutoModSettings#

Bases: TwitchObject

broadcaster_id: str#
moderator_id: str#
overall_level: Optional[int]#
disability: int#
aggression: int#
sexuality_sex_or_gender: int#
misogyny: int#
bullying: int#
swearing: int#
race_ethnicity_or_religion: int#
sex_based_terms: int#
__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.api.ChannelFollower#

Bases: TwitchObject

followed_at: datetime#
user_id: str#
user_name: str#
user_login: 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.api.ChannelFollowersResult#

Bases: AsyncIterTwitchObject[ChannelFollower]

total: int#
data: List[ChannelFollower]#
__init__(_data, **kwargs)#
static __new__(cls, *args, **kwds)#
current_cursor()#

Provides the currently used forward pagination cursor

Return type:

Optional[str]

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.api.FollowedChannel#

Bases: TwitchObject

broadcaster_id: str#
broadcaster_login: str#
broadcaster_name: str#
followed_at: datetime#
__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.api.FollowedChannelsResult#

Bases: AsyncIterTwitchObject[FollowedChannel]

total: int#
data: List[FollowedChannel]#
__init__(_data, **kwargs)#
static __new__(cls, *args, **kwds)#
current_cursor()#

Provides the currently used forward pagination cursor

Return type:

Optional[str]

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.api.ContentClassificationLabel#

Bases: TwitchObject

id: str#
description: str#
name: 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.api.AdSchedule#

Bases: TwitchObject

snooze_count: int#

The number of snoozes available for the broadcaster.

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.

duration: int#

The length in seconds of the scheduled upcoming ad break.

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)#
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.api.AdSnoozeResponse#

Bases: TwitchObject

snooze_count: int#

The number of snoozes available for the broadcaster.

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

__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.api.SendMessageResponse#

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

message_id: str#

The message id for the message that was sent.

is_sent: bool#

If the message passed all checks and was sent.

drop_reason: Optional[SendMessageDropReason]#

The reason the message was dropped, if any.

class twitchAPI.object.api.ChannelModerator#

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_id: str#

An ID that uniquely identifies the channel this user can moderate.

broadcaster_login: str#

The channel’s login name.

broadcaster_name: str#

The channels’ display name.

class twitchAPI.object.api.UserEmotesResponse#

Bases: AsyncIterTwitchObject

__init__(_data, **kwargs)#
static __new__(cls, *args, **kwds)#
current_cursor()#

Provides the currently used forward pagination cursor

Return type:

Optional[str]

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

template: str#

A templated URL. Uses the values from the id, format, scale, and theme_mode fields to replace the like-named placeholder strings in the templated URL to create a CDN (content delivery network) URL that you use to fetch the emote.

data: List[UserEmote]#