Objects used by the Twitch API

class twitchAPI.object.api.TwitchUser

Bases: TwitchObject

id:

Default:

login:

Default:

display_name:

Default:

type:

Default:

broadcaster_type:

Default:

description:

Default:

profile_image_url:

Default:

offline_image_url:

Default:

view_count:

Default:

email:

Default: = None

created_at:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.TwitchUserFollow

Bases: TwitchObject

from_id:

Default:

from_login:

Default:

from_name:

Default:

to_id:

Default:

to_login:

Default:

to_name:

Default:

followed_at:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.TwitchUserFollowResult

Bases: AsyncIterTwitchObject[TwitchUserFollow]

total:

Default:

data:

Default:

__init__(_data, **kwargs)

static __new__(cls, *args, **kwds)

current_cursor()

Return type:

Default:

Provides the currently used forward pagination cursor

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.DateRange

Bases: TwitchObject

ended_at:

Default:

started_at:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ExtensionAnalytic

Bases: TwitchObject

extension_id:

Default:

URL:

Default:

type:

Default:

date_range:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.GameAnalytics

Bases: TwitchObject

game_id:

Default:

URL:

Default:

type:

Default:

date_range:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.CreatorGoal

Bases: TwitchObject

id:

Default:

broadcaster_id:

Default:

broadcaster_name:

Default:

broadcaster_login:

Default:

type:

Default:

description:

Default:

current_amount:

Default:

target_amount:

Default:

created_at:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.BitsLeaderboardEntry

Bases: TwitchObject

user_id:

Default:

user_login:

Default:

user_name:

Default:

rank:

Default:

score:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.BitsLeaderboard

Bases: IterTwitchObject

data:

Default:

date_range:

Default:

total:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ProductCost

Bases: TwitchObject

amount:

Default:

type:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ProductData

Bases: TwitchObject

domain:

Default:

sku:

Default:

cost:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ExtensionTransaction

Bases: TwitchObject

id:

Default:

timestamp:

Default:

broadcaster_id:

Default:

broadcaster_login:

Default:

broadcaster_name:

Default:

user_id:

Default:

user_login:

Default:

user_name:

Default:

product_type:

Default:

product_data:

Default:

inDevelopment:

Default:

displayName:

Default:

expiration:

Default:

broadcast:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ChatSettings

Bases: TwitchObject

broadcaster_id:

Default:

moderator_id:

Default:

emote_mode:

Default:

slow_mode:

Default:

slow_mode_wait_time:

Default:

follower_mode:

Default:

follower_mode_duration:

Default:

subscriber_mode:

Default:

unique_chat_mode:

Default:

non_moderator_chat_delay:

Default:

non_moderator_chat_delay_duration:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.CreatedClip

Bases: TwitchObject

id:

Default:

edit_url:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.Clip

Bases: TwitchObject

id:

Default:

url:

Default:

embed_url:

Default:

broadcaster_id:

Default:

broadcaster_name:

Default:

creator_id:

Default:

creator_name:

Default:

video_id:

Default:

game_id:

Default:

language:

Default:

title:

Default:

view_count:

Default:

created_at:

Default:

thumbnail_url:

Default:

duration:

Default:

vod_offset:

Default:

is_featured:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.CodeStatus

Bases: TwitchObject

code:

Default:

status:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.Game

Bases: TwitchObject

box_art_url:

Default:

id:

Default:

name:

Default:

igdb_id:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.AutoModStatus

Bases: TwitchObject

msg_id:

Default:

is_permitted:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.BannedUser

Bases: TwitchObject

user_id:

Default:

user_login:

Default:

user_name:

Default:

expires_at:

Default:

created_at:

Default:

reason:

Default:

moderator_id:

Default:

moderator_login:

Default:

moderator_name:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.BanUserResponse

Bases: TwitchObject

broadcaster_id:

Default:

moderator_id:

Default:

user_id:

Default:

created_at:

Default:

end_time:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.BlockedTerm

Bases: TwitchObject

broadcaster_id:

Default:

moderator_id:

Default:

id:

Default:

text:

Default:

created_at:

Default:

updated_at:

Default:

expires_at:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.Moderator

Bases: TwitchObject

user_id:

Default:

user_login:

Default:

user_name:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.CreateStreamMarkerResponse

Bases: TwitchObject

id:

Default:

created_at:

Default:

description:

Default:

position_seconds:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.Stream

Bases: TwitchObject

id:

Default:

user_id:

Default:

user_login:

Default:

user_name:

Default:

game_id:

Default:

game_name:

Default:

type:

Default:

title:

Default:

viewer_count:

Default:

started_at:

Default:

language:

Default:

thumbnail_url:

Default:

tag_ids:

Default:

is_mature:

Default:

tags:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.StreamMarker

Bases: TwitchObject

id:

Default:

created_at:

Default:

description:

Default:

position_seconds:

Default:

URL:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.StreamMarkers

Bases: TwitchObject

video_id:

Default:

markers:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.GetStreamMarkerResponse

Bases: TwitchObject

user_id:

Default:

user_name:

Default:

user_login:

Default:

videos:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.BroadcasterSubscription

Bases: TwitchObject

broadcaster_id:

Default:

broadcaster_login:

Default:

broadcaster_name:

Default:

gifter_id:

Default:

gifter_login:

Default:

gifter_name:

Default:

is_gift:

Default:

tier:

Default:

plan_name:

Default:

user_id:

Default:

user_name:

Default:

user_login:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.BroadcasterSubscriptions

Bases: AsyncIterTwitchObject[BroadcasterSubscription]

total:

Default:

points:

Default:

data:

Default:

__init__(_data, **kwargs)

static __new__(cls, *args, **kwds)

current_cursor()

Return type:

Default:

Provides the currently used forward pagination cursor

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.UserSubscription

Bases: TwitchObject

broadcaster_id:

Default:

broadcaster_name:

Default:

broadcaster_login:

Default:

is_gift:

Default:

tier:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.StreamTag

Bases: TwitchObject

tag_id:

Default:

is_auto:

Default:

localization_names:

Default:

localization_descriptions:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.TeamUser

Bases: TwitchObject

user_id:

Default:

user_name:

Default:

user_login:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ChannelTeam

Bases: TwitchObject

broadcaster_id:

Default:

broadcaster_name:

Default:

broadcaster_login:

Default:

background_image_url:

Default:

banner:

Default:

users:

Default:

created_at:

Default:

updated_at:

Default:

info:

Default:

thumbnail_url:

Default:

team_name:

Default:

team_display_name:

Default:

id:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.UserExtension

Bases: TwitchObject

id:

Default:

version:

Default:

can_activate:

Default:

type:

Default:

name:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ActiveUserExtension

Bases: UserExtension

x:

Default:

y:

Default:

active:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

id:

Default:

version:

Default:

can_activate:

Default:

type:

Default:

name:

Default:

class twitchAPI.object.api.UserActiveExtensions

Bases: TwitchObject

panel:

Default:

overlay:

Default:

component:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.VideoMutedSegments

Bases: TwitchObject

duration:

Default:

offset:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.Video

Bases: TwitchObject

id:

Default:

stream_id:

Default:

user_id:

Default:

user_login:

Default:

user_name:

Default:

title:

Default:

description:

Default:

created_at:

Default:

published_at:

Default:

url:

Default:

thumbnail_url:

Default:

viewable:

Default:

view_count:

Default:

language:

Default:

type:

Default:

duration:

Default:

muted_segments:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ChannelInformation

Bases: TwitchObject

broadcaster_id:

Default:

broadcaster_login:

Default:

broadcaster_name:

Default:

game_name:

Default:

game_id:

Default:

broadcaster_language:

Default:

title:

Default:

delay:

Default:

tags:

Default:

content_classification_labels:

Default:

is_branded_content:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.SearchChannelResult

Bases: ChannelInformation

is_live:

Default:

tags_ids:

Default:

started_at:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

broadcaster_id:

Default:

broadcaster_login:

Default:

broadcaster_name:

Default:

game_name:

Default:

game_id:

Default:

broadcaster_language:

Default:

title:

Default:

delay:

Default:

tags:

Default:

content_classification_labels:

Default:

is_branded_content:

Default:

class twitchAPI.object.api.SearchCategoryResult

Bases: TwitchObject

id:

Default:

name:

Default:

box_art_url:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.StartCommercialResult

Bases: TwitchObject

length:

Default:

message:

Default:

retry_after:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.Cheermote

Bases: TwitchObject

min_bits:

Default:

id:

Default:

color:

Default:

images:

Default:

can_cheer:

Default:

show_in_bits_card:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.GetCheermotesResponse

Bases: TwitchObject

prefix:

Default:

tiers:

Default:

type:

Default:

order:

Default:

last_updated:

Default:

is_charitable:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.HypeTrainContribution

Bases: TwitchObject

total:

Default:

type:

Default:

user:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.HypeTrainEventData

Bases: TwitchObject

broadcaster_id:

Default:

cooldown_end_time:

Default:

expires_at:

Default:

goal:

Default:

id:

Default:

last_contribution:

Default:

level:

Default:

started_at:

Default:

top_contributions:

Default:

total:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.HypeTrainEvent

Bases: TwitchObject

id:

Default:

event_type:

Default:

event_timestamp:

Default:

version:

Default:

event_data:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.DropsEntitlement

Bases: TwitchObject

id:

Default:

benefit_id:

Default:

timestamp:

Default:

user_id:

Default:

game_id:

Default:

fulfillment_status:

Default:

updated_at:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.MaxPerStreamSetting

Bases: TwitchObject

is_enabled:

Default:

max_per_stream:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.MaxPerUserPerStreamSetting

Bases: TwitchObject

is_enabled:

Default:

max_per_user_per_stream:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.GlobalCooldownSetting

Bases: TwitchObject

is_enabled:

Default:

global_cooldown_seconds:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.CustomReward

Bases: TwitchObject

broadcaster_name:

Default:

broadcaster_login:

Default:

broadcaster_id:

Default:

id:

Default:

image:

Default:

background_color:

Default:

is_enabled:

Default:

cost:

Default:

title:

Default:

prompt:

Default:

is_user_input_required:

Default:

max_per_stream_setting:

Default:

max_per_user_per_stream_setting:

Default:

global_cooldown_setting:

Default:

is_paused:

Default:

is_in_stock:

Default:

default_image:

Default:

should_redemptions_skip_request_queue:

Default:

redemptions_redeemed_current_stream:

Default:

cooldown_expires_at:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.PartialCustomReward

Bases: TwitchObject

id:

Default:

title:

Default:

prompt:

Default:

cost:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.CustomRewardRedemption

Bases: TwitchObject

broadcaster_name:

Default:

broadcaster_login:

Default:

broadcaster_id:

Default:

id:

Default:

user_id:

Default:

user_name:

Default:

user_input:

Default:

status:

Default:

redeemed_at:

Default:

reward:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ChannelEditor

Bases: TwitchObject

user_id:

Default:

user_name:

Default:

created_at:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.BlockListEntry

Bases: TwitchObject

user_id:

Default:

user_login:

Default:

user_name:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.PollChoice

Bases: TwitchObject

id:

Default:

title:

Default:

votes:

Default:

channel_point_votes:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.Poll

Bases: TwitchObject

id:

Default:

broadcaster_name:

Default:

broadcaster_id:

Default:

broadcaster_login:

Default:

title:

Default:

choices:

Default:

channel_point_voting_enabled:

Default:

channel_points_per_vote:

Default:

status:

Default:

duration:

Default:

started_at:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.Predictor

Bases: TwitchObject

user_id:

Default:

user_name:

Default:

user_login:

Default:

channel_points_used:

Default:

channel_points_won:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.PredictionOutcome

Bases: TwitchObject

id:

Default:

title:

Default:

users:

Default:

channel_points:

Default:

top_predictors:

Default:

color:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.Prediction

Bases: TwitchObject

id:

Default:

broadcaster_id:

Default:

broadcaster_name:

Default:

broadcaster_login:

Default:

title:

Default:

winning_outcome_id:

Default:

outcomes:

Default:

prediction_window:

Default:

status:

Default:

created_at:

Default:

ended_at:

Default:

locked_at:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.RaidStartResult

Bases: TwitchObject

created_at:

Default:

is_mature:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ChatBadgeVersion

Bases: TwitchObject

id:

Default:

image_url_1x:

Default:

image_url_2x:

Default:

image_url_4x:

Default:

title:

Default:

description:

Default:

click_action:

Default:

click_url:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ChatBadge

Bases: TwitchObject

set_id:

Default:

versions:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.Emote

Bases: TwitchObject

id:

Default:

name:

Default:

images:

Default:

tier:

Default:

emote_type:

Default:

emote_set_id:

Default:

format:

Default:

scale:

Default:

theme_mode:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.GetEmotesResponse

Bases: IterTwitchObject

data:

Default:

template:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.EventSubSubscription

Bases: TwitchObject

id:

Default:

status:

Default:

type:

Default:

version:

Default:

condition:

Default:

created_at:

Default:

transport:

Default:

cost:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.GetEventSubSubscriptionResult

Bases: AsyncIterTwitchObject[EventSubSubscription]

total:

Default:

total_cost:

Default:

max_total_cost:

Default:

data:

Default:

__init__(_data, **kwargs)

static __new__(cls, *args, **kwds)

current_cursor()

Return type:

Default:

Provides the currently used forward pagination cursor

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.StreamCategory

Bases: TwitchObject

id:

Default:

name:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ChannelStreamScheduleSegment

Bases: TwitchObject

id:

Default:

start_time:

Default:

end_time:

Default:

title:

Default:

canceled_until:

Default:

category:

Default:

is_recurring:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.StreamVacation

Bases: TwitchObject

start_time:

Default:

end_time:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ChannelStreamSchedule

Bases: AsyncIterTwitchObject[ChannelStreamScheduleSegment]

segments:

Default:

broadcaster_id:

Default:

broadcaster_name:

Default:

broadcaster_login:

Default:

vacation:

Default:

__init__(_data, **kwargs)

static __new__(cls, *args, **kwds)

current_cursor()

Return type:

Default:

Provides the currently used forward pagination cursor

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ChannelVIP

Bases: TwitchObject

user_id:

Default:

user_name:

Default:

user_login:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.UserChatColor

Bases: TwitchObject

user_id:

Default:

user_name:

Default:

user_login:

Default:

color:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.Chatter

Bases: TwitchObject

user_id:

Default:

user_login:

Default:

user_name:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.GetChattersResponse

Bases: AsyncIterTwitchObject[Chatter]

data:

Default:

total:

Default:

__init__(_data, **kwargs)

static __new__(cls, *args, **kwds)

current_cursor()

Return type:

Default:

Provides the currently used forward pagination cursor

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ShieldModeStatus

Bases: TwitchObject

is_active:

Default:

moderator_id:

Default:

moderator_login:

Default:

moderator_name:

Default:

last_activated_at:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.CharityAmount

Bases: TwitchObject

value:

Default:

decimal_places:

Default:

currency:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.CharityCampaign

Bases: TwitchObject

id:

Default:

broadcaster_id:

Default:

broadcaster_login:

Default:

broadcaster_name:

Default:

charity_name:

Default:

charity_description:

Default:

charity_logo:

Default:

charity_website:

Default:

current_amount:

Default:

target_amount:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.CharityCampaignDonation

Bases: TwitchObject

id:

Default:

campaign_id:

Default:

user_id:

Default:

user_name:

Default:

user_login:

Default:

amount:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.AutoModSettings

Bases: TwitchObject

broadcaster_id:

Default:

moderator_id:

Default:

overall_level:

Default:

disability:

Default:

aggression:

Default:

sexuality_sex_or_gender:

Default:

misogyny:

Default:

bullying:

Default:

swearing:

Default:

race_ethnicity_or_religion:

Default:

sex_based_terms:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ChannelFollower

Bases: TwitchObject

followed_at:

Default:

user_id:

Default:

user_name:

Default:

user_login:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ChannelFollowersResult

Bases: AsyncIterTwitchObject[ChannelFollower]

total:

Default:

data:

Default:

__init__(_data, **kwargs)

static __new__(cls, *args, **kwds)

current_cursor()

Return type:

Default:

Provides the currently used forward pagination cursor

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.FollowedChannel

Bases: TwitchObject

broadcaster_id:

Default:

broadcaster_login:

Default:

broadcaster_name:

Default:

followed_at:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.FollowedChannelsResult

Bases: AsyncIterTwitchObject[FollowedChannel]

total:

Default:

data:

Default:

__init__(_data, **kwargs)

static __new__(cls, *args, **kwds)

current_cursor()

Return type:

Default:

Provides the currently used forward pagination cursor

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.ContentClassificationLabel

Bases: TwitchObject

id:

Default:

description:

Default:

name:

Default:

__init__(**kwargs)

to_dict(include_none_values=False)

build dict based on annotation types

Parameters:

include_none_values (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.AdSchedule

Bases: TwitchObject

snooze_count:

Default:

The number of snoozes available for the broadcaster.

snooze_refresh_at:

Default:

The UTC timestamp when the broadcaster will gain an additional snooze.

next_ad_at:

Default:

The UTC timestamp of the broadcaster’s next scheduled ad. Empty if the channel has no ad scheduled or is not live.

duration:

Default:

The length in seconds of the scheduled upcoming ad break.

last_ad_at:

Default:

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:

Default:

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 (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

class twitchAPI.object.api.AdSnoozeResponse

Bases: TwitchObject

snooze_count:

Default:

The number of snoozes available for the broadcaster.

snooze_refresh_at:

Default:

The UTC timestamp when the broadcaster will gain an additional snooze

next_ad_at:

Default:

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 (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

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 (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

message_id:

Default:

The message id for the message that was sent.

is_sent:

Default:

If the message passed all checks and was sent.

drop_reason:

Default:

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 (

Default:) – if fields that have None values should be included in the dictionary

Return type:

Default:

broadcaster_id:

Default:

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

broadcaster_login:

Default:

The channel’s login name.

broadcaster_name:

Default:

The channels’ display name.