All Available Functions
This page contains all the public method available to work with
Note
All Examples on the page assumes that app
is the Bot
class instance
Get User Info
Get User Videos
- Bot().iter_user_videos(username: str, sort: str = "TIME", pages: int = 1, cursor: str = None, wait_time: int = 2)
Get the Videos of the specified username as a generator
- Arguments
- Return
- Returns:
Generator : (
UserVideos
, list[Video
])
for _, videos in app.iter_user_videos('kharltayyab'): print(videos)
Get User Video Clips
Searching a Keyword
- Bot().search(keyword: str, filter_: str = "SearchStreams", pages: int = 1, wait_time: int = 2, cursor: str = None)
Search for a on Twitch
- Arguments
results = app.search('kharltayyab') for result in results: print(result)
- Bot().iter_search(keyword: str, filter_: str = "SearchStreams", pages: int = 1, wait_time: int = 2, cursor: str = None)
Search for a on Twitch as a generator
- Arguments
for _, results in app.iter_search('kharltayyab'): print(results)
Get Top Streams
- Bot().iter_top_streams(tags: List[str] = None, pages: int = 1, wait_time: int = 2, cursor: str = None)
Get Twitch Top Streams as generator
- Arguments
- Return
- Returns:
TopStreams
, list[Stream
]
for _, streams in app.iter_top_streams(): print(streams)
Get Top Games
- Bot().iter_top_games(tags: List[str] = None, pages: int = 1, wait_time: int = 2, cursor: str = None)
Get Twitch Top Games as generator
- Arguments
- Return
- Returns:
TopStreams
, list[Game
]
for _, games in app.iter_top_games(): print(games)
Get Game Streams
- Bot().iter_top_games(game: Union[str, int, Game], tags: List[str] = None, sort: str = "VIEWER_COUNT", pages: int = 1, wait_time: int = 2, cursor: str = None)
Get Streams of specific game as generator
- Arguments
- Return
- Returns:
GameStreams
, list[Stream
]
for _, streams in app.iter_game_streams(): print(streams)
Get Game Clips
Get Game Videos
- Bot().iter_game_videos(game: Union[str, int, Game], sort: str = "VIEWER_COUNT", languages: str = None, pages: int = 1, wait_time: int = 2, cursor: str = None)
Get Videos of specific game as generator
- Arguments
- Return
- Returns:
GameVideos
, list[Video
]
for _, videos in app.get_game_videos(): print(videos)