Skip to main content

A Python 3.7 implementation of the Twitch Helix API and its Webhook

Project description

Python Twitch API

PyPI verion PyPI verion Twitch API version Documentation Status

This is a full implementation of the Twitch API and its Webhook in python 3.7.

Installation

Install using pip:

pip install twitchAPI

Documentation

A full API documentation can be found on readthedocs.org.

Usage

Basic API calls

Setting up a Instance of the Twitch API and get your User ID:

from twitchAPI.twitch import Twitch

# create instance of twitch API
twitch = Twitch('my_app_id', 'my_app_secret')

# get ID of user
user_info = twitch.get_users(logins=['my_username'])
user_id = user_info[0]['id']

Authentication

The Twitch API knows 2 different authentications. App and User Authentication. Which one you need (or if one at all) depends on what calls you want to use.

Its always good to get at least App authentication even for calls where you dont need it since the rate limmits are way better for authenticated calls.

App Authentication

App authentication is super simple, just do the following:

# add App authentication
twitch.authenticate_app([])

User Authentication

To get a user auth token, the user has to explicitly click "Authorize" on the twitch website. You can use various online services to generate a token or use my build in authenticator. For my authenticator you have to add the following URL as a "OAuth Redirect URL": http://localhost:17563 You can set that here in your twitch dev dashboard.

from twitchAPI.oauth import UserAuthenticator
from twitch.types import AuthScope

target_scope = [AuthScope.READ_BITS]
auth = UserAuthenticator(twitch, target_scope, force_verify=False)
# this will open your default browser and prompt you with the twitch verification website
token, refresh_token = auth.authenticate()
# add User authentication
twitch.set_user_authentication(token, target_scope)

You can reuse this token and use the refresh_token to renew it:

from twitchAPI.oauth import refresh_access_token
new_token, new_refresh_token = refresh_access_token('refresh_token', 'client_id', 'client_secret')

Webhook

Requirements

You need to have a public IP with a port open. That port will be 80 by default. Authentication is off by default but you can choose to authenticate to use some Webhook Topics or to get more information.
Please note that Your Endpoint URL has to be HTTPS if you choose to authenticate which means that you probably need a reverse proxy like nginx.

Start Webhook

Example on how to set up a webhook and start it:

hook = twitch.get_webhook('https://my.url.com', port=80)
hook.authenticate(twitch.get_auth_token())
hook.secret = 'some_fancy_long_secret_string'
hook.start()

Subscribing to Webhook Topics

Define a callback function and subscribe to a event:

from uuid import UUID
from pprint import pprint

def callback_user_changed(uuid: UUID, data: dict) -> None:
    print(f'Callback for UUID {str(uuid)}')
    pprint(data)

success, sub_uuid = hook.subscribe_user_changed(user_id, callback_user_changed)

The subscription function returns a UUID that identifies this subscription. This means you can use the same callback function for multiple subscriptions.

To unsubscribe, just use that UUID from the subscription:

success = hook.unsubscribe_user_changed(sub_uuid)

Stopping the Webhook

Stopping the webhook:

hook.stop()

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for twitchAPI, version 1.0
Filename, size File type Python version Upload date Hashes
Filename, size twitchAPI-1.0.tar.gz (3.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page