Skip to content

JayexDesigns/python-twitch-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 

Repository files navigation

Python Twitch API (WIP)

A python library to communicate with the twitch API easily


Installing

For now, the way to install this library is to clone this repository or download twitchAPI.py, while having this file in the same folder of your project will make it available to import the library.

import twitchAPI

Authentication

To use this library first you need to have a twitch application, go to the Twitch developer console and go to the apps tab, then click the register your application button. Add a name and a category to your application and create it, once it's done you can click on manage to get the Client ID and the Client Secret, both needed to use the API.


Once you have both the Client ID and the Client Secret you can use this library, you will need an OAuth Token before using any of the library functions, here is an example code on how to get the OAuth Token:

import twitchAPI
clientId = "Your Client ID"
clientSecret = "Your Client Secret"

auth = twitchAPI.authentication(clientId, clientSecret)
auth.fullToken #This is the OAuth Token you will need to use

Use

Now you can start gathering information and interacting with the API, here there's a list of methods you can call and what they do:

  • searchChannel(clientId, authToken, streamerName) -> This will give you a dictionary with some information of the streamer, including the streamer id
  • getUser(clientId, authToken, streamerId) -> This will give you a dictionary with some information of the user such as it's description
  • getChannelInfo(clientId, authToken, streamerId) -> This will give you a dictionary with information of the streamer like the game he/she is playing
  • getUserFollows(clientId, authToken, streamerId) -> Returns the follower quantity a streamer has
  • getStreamInfo(clientId, authToken, streamerId) -> This gives information about the current stream of the given streamer
  • getAllStreamerInfo(clientId, authToken, streamerName) -> This method mixes all of the above and returns a dictionary with all the information

About

Easy way to access twitch data with python

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages