API¶

Warning

This documentation is currently a work in progress and is still rough around the edges. Not finding what you are looking for? Please open an issue describing your troubles on python-twitch’s github page!

twitch.api.v3¶

Accumulate functionality from all submodules https://github.com/justintv/Twitch-API/blob/master/v3_resources/

twitch.api.v3.root()¶: Return the root of the api.

twitch.api.v3.blocks¶

This module implements the functionality described here https://github.com/justintv/Twitch-API/blob/master/v3_resources/blocks.md

twitch.api.v3.channels¶

This module implements the functionality described here https://github.com/justintv/Twitch-API/blob/master/v3_resources/channels.md

twitch.api.v3.channels.by_name(name)¶

Get channel object by name.

Parameters:	name – Name of the channel
Returns:	Channel Object as JSON

twitch.api.v3.channels.teams(name)¶

Returns team objects associated with the channel

Parameters:	name – Name of the channel
Returns:	Channel Object as JSON

twitch.api.v3.chat¶

This module implements the functionality described here https://github.com/justintv/Twitch-API/blob/master/v3_resources/chat.md

twitch.api.v3.chat.by_channel(name)¶

Get links object to other chat endpoints

Parameters:	name – Name of the channel
Returns:	JSON Object describing other chat endpoints

twitch.api.v3.chat.badges(name)¶

Get chat badges for channel

Parameters:	name – Name of the channel
Returns:	JSON Object describing all channel badges

twitch.api.v3.chat.emoticons()¶

Returns a list of all emoticon objects for Twitch.

Returns:	JSON Object describing all emoticon objects

twitch.api.v3.follows¶

This module implements the functionality described here https://github.com/justintv/Twitch-API/blob/master/v3_resources/follows.md

twitch.api.v3.follows.by_channel(name, limit=25, offset=0, direction=Direction.DESC)¶

Get channel’s list of following users

Parameters:	name – Name of the channel limit – Maximum number of objects in array. Default is 25. Maximum is 100. offset – Object offset for pagination. Default is 0. direction – Creation date sorting direction. Default is ‘desc’. Valid values are ‘asc’ and ‘desc’.
Returns:	JSON List of Follow objects

twitch.api.v3.follows.by_user(name, limit=25, offset=0, direction=Direction.DESC, sort_by=SortBy.CREATED_AT)¶

twitch.api.v3.follows.status(user, target)¶