Twitch Types

This page contains all the Data Class returned by the different methods

UserVideos

class UserVideos

Bases : BaseGeneratorClass

Note

This Object is JSON Serializable and Iterable

Reference:: twitch_types.types.user.UserVideos

Attributes:

results: list[Video]: List of User Videos

cursor: str: Cursor for next page

has_next_page: bool: Is next page of results available

username: str | int: User Identifier from User

Methods:

get_next_page()

Get next page of videos if available

Return: list[Video]

__repr__()

Developer Representation of the Object

Return: str

Returns:: UserVideos(user={user_identifier}, sort={sorting}, results={number_of_results})

UserClips

class UserClips

Bases : BaseGeneratorClass

Note

This Object is JSON Serializable and Iterable

Reference:: twitch_types.types.user.UserClips

Attributes:

results: list[Clip]: List of User Clips

cursor: str: Cursor for next page

has_next_page: bool: Is next page of results available

username: str | int: User Identifier from User

Methods:

get_next_page()

Get next page of videos if available

Return: list[Clip]

__repr__()

Developer Representation of the Object

Return: str

Returns:: UserClips(user={user_identifier}, sort={sorting}, results={number_of_results})

GameStreams

class GameStreams

Bases : BaseGeneratorClass

Note

This Object is JSON Serializable and Iterable

Reference:: twitch_types.types.game.GameStreams

Attributes:

results: list[Stream]: List of Game Stream

cursor: str: Cursor for next page

has_next_page: bool: Is next page of results available

game: Game: Actual Game in query

Methods:

get_next_page()

Get next page of videos if available

Return: list[Stream]

__repr__()

Developer Representation of the Object

Return: str

Returns:: GameStreams(game={game}, tags={tags}, sort={sorting}, results={number_of_results})

GameClips

class GameClips

Bases : BaseGeneratorClass

Note

This Object is JSON Serializable and Iterable

Reference:: twitch_types.types.game.GameClips

Attributes:

results: list[Clip]: List of Game Clip

cursor: str: Cursor for next page

has_next_page: bool: Is next page of results available

game: Game: Actual Game in query

Methods:

get_next_page()

Get next page of videos if available

Return: list[Stream]

__repr__()

Developer Representation of the Object

Return: str

Returns:: GameClips(game={game}, languages={tags}, sort={sorting}, results={number_of_results})

GameVideos

class GameVideos

Bases : BaseGeneratorClass

Note

This Object is JSON Serializable and Iterable

Reference:: twitch_types.types.game.GameVideos

Attributes:

results: list[Game]: List of Game Videos

cursor: str: Cursor for next page

has_next_page: bool: Is next page of results available

game: Game: Actual Game in query

Methods:

get_next_page()

Get next page of videos if available

Return: list[Game]

__repr__()

Developer Representation of the Object

Return: str

Returns:: GameVideos(game={game}, languages={tags}, sort={sorting}, results={number_of_results})

Search

class Search

Bases : BaseGeneratorClass

Note

This Object is JSON Serializable and Iterable

Reference:: twitch_types.types.search.Search

Attributes:

results: list[Game | Clip | Stream | User]: List of results

cursor: str: Cursor for next page

has_next_page: bool: Is next page of results available

Methods:

get_next_page()

Get next page of videos if available

Return: list[Game | Clip | Stream | User]

__repr__()

Developer Representation of the Object

Return: str

Returns:: Search(keyword={keyword}, filter={filter}, results={number_of_results})

TopGames

class TopGames

Bases : BaseGeneratorClass

Note

This Object is JSON Serializable and Iterable

Reference:: twitch_types.types.top.TopGames

Attributes:

results: list[Game]: List of results

cursor: str: Cursor for next page

has_next_page: bool: Is next page of results available

Methods:

get_next_page()

Get next page of videos if available

Return: list[Game]

__repr__()

Developer Representation of the Object

Return: str

Returns:: TopGames(tags={tags}, results={number_of_results})

TopStreams

class TopStreams

Bases : BaseGeneratorClass

Note

This Object is JSON Serializable and Iterable

Reference:: twitch_types.types.top.TopStreams

Attributes:

results: list[Stream]: List of results

cursor: str: Cursor for next page

has_next_page: bool: Is next page of results available

Methods:

get_next_page()

Get next page of videos if available

Return: list[Stream]

__repr__()

Developer Representation of the Object

Return: str

Returns:: TopStreams(tags={tags}, results={number_of_results})

Video

class Video

Bases : dict

Note

This Object is JSON Serializable and Iterable

Reference:: tweety.types.twitch_types.Video

Attributes:

id: int: ID of the Video

date: datetime.datetime: DateTime at which the Video was created

duration: str: Duration of video in seconds

title: str: Title of the Video

view_count: str: View Count of the Video

user: User: User who have uploaded this video

game: Game: Which game is begin played in Twitch

Methods:

get_link()

Get m3u8 stream link of the video

Return: str

__repr__()

Developer Representation of the Object

Return: str

Value:: Video(id={id_of_video}, title={title_of_video}, date={date_of_video}, duration={duration_of_video})

Game

class Game

Bases : dict

Note

This Object is JSON Serializable

Reference:: tweety.types.twitch_types.Game

Attributes:

id: str: ID of the Game

display_name: str: Display Name of the game

name: str: Name of the game

original_release_date: datetime.datetime: Release Date of the Game

viewers_count: str: Viewer Count of the Video

followers_count: str: Followers Count of the Video

broadcasters_count: str: Broadcaster Count of the Video

Methods:

__repr__()

Developer Representation of the Object

Return: str

Value:: Game(id={id_of_the_game}, name={name_of_the_game})

User

class User

Bases : dict

Note

This Object is JSON Serializable

Reference:: tweety.types.twitch_types.User

Attributes:

id: int: ID of the user

channel_id: int: Channel ID of the user

date: datetime.datetime: Date time of the user creation

description: str: Description of the user

display_name: str: Display Name of the User

followers_count: int: Number of followers this user has

username: str: username of the user

is_mature: bool: Do user post mature content [18+]

is_affiliate: bool: Is user affiliate

is_partner: bool: Is user partner of twitch

is_staff: bool: Is user staff member of twitch

is_site_admin: bool: Is user site admin of twitch

is_global_mod: bool: Is user global moderaot of twitch

stream: Stream | None: Ongoing Stream of the user

socials: list[Social]: Social Links of the user

Methods:

get_videos(sort: str = 'TIME', pages=1, cursor=None, wait_time=2): Get Video of the User

iter_videos(sort: str = 'TIME', pages=1, cursor=None, wait_time=2): Get Video of the User as generator

get_clips(sort: str = 'ALL_TIME', pages=1, cursor=None, wait_time=2): Get Clips of the User

iter_clips(sort: str = 'ALL_TIME', pages=1, cursor=None, wait_time=2): Get Clips of the User as generator

__repr__()

Developer Representation of the Object

Return: str

Value:: User(id={id_of_user}, name={name_of_user})

Stream

class Stream

Bases : dict

Note

This Object is JSON Serializable

Reference:: tweety.types.twitch_types.Stream

Attributes:

id: str: ID of the Stream

fps: int: FPS of stream

broadcaster_software: str: Name of software begin used for broadcasting / stream

game: Game: Game begin played in stream

date: datetime.datetime: Datetime at which the stream was started

title: str: Title of stream

view_count: int: Total Views of the Stream

user: User: User who is streaming

type: str: Type of the stream

Methods:

get_link()

Get m3u8 streamable link of the stream

Return: str

__repr__()

Developer Representation of the Object

Return: str

Value:: Stream(id={id}, type={type}, game={game})

Clip

class Clip

Bases : dict

Note

This Object is JSON Serializable

Reference:: tweety.types.twitch_types.Clip

Attributes:

id: str: ID of the Clip

duration: int: Duration of Clip in seconds

is_featured: bool: Is this clip being featured

slug: str: Unique slug of clip

date: datetime.datetime: Datetime at which the clip was created

title: str: Title of Clip

view_count: int: Total Views of the Clip

user: User: User who is streaming

video_Offset_seconds: int: Offset of the video in seconds

video: Video: Video from which this clip was created

game: Game: Game being played in clip

user: User: Who is the owner of this clip

Methods:

get_link()

Get m3u8 streamable link of the clip

Return: str

__repr__()

Developer Representation of the Object

Return: str

Value:: Clip(video={video}, game={game}, videoOffsetSecond={offset_seconds})

Twitch Types

UserVideos

UserClips

GameStreams

GameClips

GameVideos

Search

TopGames

TopStreams

Video

Game

User

Social

Stream

Clip