# Python Twitch API
[](https://pypi.org/project/twitchAPI/) [](https://pepy.tech/project/twitchapi) [](https://pypi.org/project/twitchAPI/) [](https://dev.twitch.tv/docs/api) [](https://pytwitchapi.readthedocs.io/en/latest/?badge=latest)
This is a full implementation of the Twitch Helix API, PubSub, EventSub and Chat in python 3.7+.
## Installation
Install using pip:
```pip install twitchAPI```
## Documentation and Support
A full API documentation can be found [on readthedocs.org](https://pytwitchapi.readthedocs.io/en/stable/index.html).
For support please join the [Twitch API discord server](https://discord.gg/tu2Dmc7gpd)
## Usage
### Basic API calls
Setting up an Instance of the Twitch API and get your User ID:
```python
from twitchAPI.twitch import Twitch
from twitchAPI.helper import first
import asyncio
async def twitch_example():
# initialize the twitch instance, this will by default also create a app authentication for you
twitch = await Twitch('app_id', 'app_secret')
# call the API for the data of your twitch user
# this returns a async generator that can be used to iterate over all results
# but we are just interested in the first result
# using the first helper makes this easy.
user = await first(twitch.get_users(logins='your_twitch_user'))
# print the ID of your user or do whatever else you want with it
print(user.id)
# run this example
asyncio.run(twitch_example())
```
### 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.
It's always good to get at least App authentication even for calls where you don't need it since the rate limits are way better for authenticated calls.
**Please read the docs for more details and examples on how to set and use Authentication!**
#### App Authentication
App authentication is super simple, just do the following:
```python
from twitchAPI.twitch import Twitch
twitch = await Twitch('my_app_id', 'my_app_secret')
```
### 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](https://dev.twitch.tv/console).
```python
from twitchAPI.twitch import Twitch
from twitchAPI.oauth import UserAuthenticator
from twitchAPI.type import AuthScope
twitch = await Twitch('my_app_id', 'my_app_secret')
target_scope = [AuthScope.BITS_READ]
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 = await auth.authenticate()
# add User authentication
await twitch.set_user_authentication(token, target_scope, refresh_token)
```
You can reuse this token and use the refresh_token to renew it:
```python
from twitchAPI.oauth import refresh_access_token
new_token, new_refresh_token = await refresh_access_token('refresh_token', 'client_id', 'client_secret')
```
### AuthToken refresh callback
Optionally you can set a callback for both user access token refresh and app access token refresh.
```python
from twitchAPI.twitch import Twitch
async def user_refresh(token: str, refresh_token: str):
print(f'my new user token is: {token}')
async def app_refresh(token: str):
print(f'my new app token is: {token}')
twitch = await Twitch('my_app_id', 'my_app_secret')
twitch.app_auth_refresh_callback = app_refresh
twitch.user_auth_refresh_callback = user_refresh
```
## EventSub
EventSub lets you listen for events that happen on Twitch.
The EventSub client runs in its own thread, calling the given callback function whenever an event happens.
There are multiple EventSub transports available, used for different use cases.
See here for more info about EventSub in general and the different Transports, including code examples: [on readthedocs](https://pytwitchapi.readthedocs.io/en/stable/modules/twitchAPI.eventsub.html)
## PubSub
PubSub enables you to subscribe to a topic, for updates (e.g., when a user cheers in a channel).
A more detailed documentation can be found [here on readthedocs](https://pytwitchapi.readthedocs.io/en/stable/modules/twitchAPI.pubsub.html)
```python
from twitchAPI.pubsub import PubSub
from twitchAPI.twitch import Twitch
from twitchAPI.helper import first
from twitchAPI.type import AuthScope
from twitchAPI.oauth import UserAuthenticator
import asyncio
from pprint import pprint
from uuid import UUID
APP_ID = 'my_app_id'
APP_SECRET = 'my_app_secret'
USER_SCOPE = [AuthScope.WHISPERS_READ]
TARGET_CHANNEL = 'teekeks42'
async def callback_whisper(uuid: UUID, data: dict) -> None:
print('got callback for UUID ' + str(uuid))
pprint(data)
async def run_example():
# setting up Authentication and getting your user id
twitch = await Twitch(APP_ID, APP_SECRET)
auth = UserAuthenticator(twitch, [AuthScope.WHISPERS_READ], force_verify=False)
token, refresh_token = await auth.authenticate()
# you can get your user auth token and user auth refresh token following the example in twitchAPI.oauth
await twitch.set_user_authentication(token, [AuthScope.WHISPERS_READ], refresh_token)
user = await first(twitch.get_users(logins=[TARGET_CHANNEL]))
# starting up PubSub
pubsub = PubSub(twitch)
pubsub.start()
# you can either start listening before or after you started pubsub.
uuid = await pubsub.listen_whispers(user.id, callback_whisper)
input('press ENTER to close...')
# you do not need to unlisten to topics before stopping but you can listen and unlisten at any moment you want
await pubsub.unlisten(uuid)
pubsub.stop()
await twitch.close()
asyncio.run(run_example())
```
## Chat
A simple twitch chat bot.
Chat bots can join channels, listen to chat and reply to messages, commands, subscriptions and many more.
A more detailed documentation can be found [here on readthedocs](https://pytwitchapi.readthedocs.io/en/stable/modules/twitchAPI.chat.html)
### Example code for a simple bot
```python
from twitchAPI.twitch import Twitch
from twitchAPI.oauth import UserAuthenticator
from twitchAPI.type import AuthScope, ChatEvent
from twitchAPI.chat import Chat, EventData, ChatMessage, ChatSub, ChatCommand
import asyncio
APP_ID = 'my_app_id'
APP_SECRET = 'my_app_secret'
USER_SCOPE = [AuthScope.CHAT_READ, AuthScope.CHAT_EDIT]
TARGET_CHANNEL = 'teekeks42'
# this will be called when the event READY is triggered, which will be on bot start
async def on_ready(ready_event: EventData):
print('Bot is ready for work, joining channels')
# join our target channel, if you want to join multiple, either call join for each individually
# or even better pass a list of channels as the argument
await ready_event.chat.join_room(TARGET_CHANNEL)
# you can do other bot initialization things in here
# this will be called whenever a message in a channel was send by either the bot OR another user
async def on_message(msg: ChatMessage):
print(f'in {msg.room.name}, {msg.user.name} said: {msg.text}')
# this will be called whenever someone subscribes to a channel
async def on_sub(sub: ChatSub):
print(f'New subscription in {sub.room.name}:\\n'
f' Type: {sub.sub_plan}\\n'
f' Message: {sub.sub_message}')
# this will be called whenever the !reply command is issued
async def test_command(cmd: ChatCommand):
if len(cmd.parameter) == 0:
await cmd.reply('you did not tell me what to reply with')
else:
await cmd.reply(f'{cmd.user.name}: {cmd.parameter}')
# this is where we set up the bot
async def run():
# set up twitch api instance and add user authentication with some scopes
twitch = await Twitch(APP_ID, APP_SECRET)
auth = UserAuthenticator(twitch, USER_SCOPE)
token, refresh_token = await auth.authenticate()
await twitch.set_user_authentication(token, USER_SCOPE, refresh_token)
# create chat instance
chat = await Chat(twitch)
# register the handlers for the events you want
# listen to when the bot is done starting up and ready to join channels
chat.register_event(ChatEvent.READY, on_ready)
# listen to chat messages
chat.register_event(ChatEvent.MESSAGE, on_message)
# listen to channel subscriptions
chat.register_event(ChatEvent.SUB, on_sub)
# there are more events, you can view them all in this documentation
# you can directly register commands and their handlers, this will register the !reply command
chat.register_command('reply', test_command)
# we are done with our setup, lets start this bot up!
chat.start()
# lets run till we press enter in the console
try:
input('press ENTER to stop\n')
finally:
# now we can close the chat bot and the twitch api client
chat.stop()
await twitch.close()
# lets run our setup
asyncio.run(run())
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Teekeks/pyTwitchAPI",
"name": "twitchAPI",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "twitch, twitch.tv, chat, bot, event sub, EventSub, pub sub, PubSub, helix, api",
"author": "Lena \"Teekeks\" During",
"author_email": "info@teawork.de",
"download_url": "https://files.pythonhosted.org/packages/eb/32/2f7538599535610d7a28ddfde3545968f6d868e3c76afb2edda63a428bdd/twitchapi-4.3.1.tar.gz",
"platform": null,
"description": "# Python Twitch API\r\n\r\n[](https://pypi.org/project/twitchAPI/) [](https://pepy.tech/project/twitchapi) [](https://pypi.org/project/twitchAPI/) [](https://dev.twitch.tv/docs/api) [](https://pytwitchapi.readthedocs.io/en/latest/?badge=latest)\r\n\r\n\r\nThis is a full implementation of the Twitch Helix API, PubSub, EventSub and Chat in python 3.7+.\r\n\r\n\r\n## Installation\r\n\r\nInstall using pip:\r\n\r\n```pip install twitchAPI```\r\n\r\n## Documentation and Support\r\n\r\nA full API documentation can be found [on readthedocs.org](https://pytwitchapi.readthedocs.io/en/stable/index.html).\r\n\r\nFor support please join the [Twitch API discord server](https://discord.gg/tu2Dmc7gpd)\r\n\r\n## Usage\r\n\r\n### Basic API calls\r\n\r\nSetting up an Instance of the Twitch API and get your User ID:\r\n\r\n```python\r\nfrom twitchAPI.twitch import Twitch\r\nfrom twitchAPI.helper import first\r\nimport asyncio\r\n\r\nasync def twitch_example():\r\n # initialize the twitch instance, this will by default also create a app authentication for you\r\n twitch = await Twitch('app_id', 'app_secret')\r\n # call the API for the data of your twitch user\r\n # this returns a async generator that can be used to iterate over all results\r\n # but we are just interested in the first result\r\n # using the first helper makes this easy.\r\n user = await first(twitch.get_users(logins='your_twitch_user'))\r\n # print the ID of your user or do whatever else you want with it\r\n print(user.id)\r\n\r\n# run this example\r\nasyncio.run(twitch_example())\r\n```\r\n\r\n### Authentication\r\n\r\nThe Twitch API knows 2 different authentications. App and User Authentication.\r\nWhich one you need (or if one at all) depends on what calls you want to use.\r\n\r\nIt's always good to get at least App authentication even for calls where you don't need it since the rate limits are way better for authenticated calls.\r\n\r\n**Please read the docs for more details and examples on how to set and use Authentication!**\r\n\r\n#### App Authentication\r\n\r\nApp authentication is super simple, just do the following:\r\n\r\n```python\r\nfrom twitchAPI.twitch import Twitch\r\ntwitch = await Twitch('my_app_id', 'my_app_secret')\r\n```\r\n\r\n### User Authentication\r\n\r\nTo 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.\r\nFor my Authenticator you have to add the following URL as a \"OAuth Redirect URL\": ```http://localhost:17563```\r\nYou can set that [here in your twitch dev dashboard](https://dev.twitch.tv/console).\r\n\r\n\r\n```python\r\nfrom twitchAPI.twitch import Twitch\r\nfrom twitchAPI.oauth import UserAuthenticator\r\nfrom twitchAPI.type import AuthScope\r\n\r\ntwitch = await Twitch('my_app_id', 'my_app_secret')\r\n\r\ntarget_scope = [AuthScope.BITS_READ]\r\nauth = UserAuthenticator(twitch, target_scope, force_verify=False)\r\n# this will open your default browser and prompt you with the twitch verification website\r\ntoken, refresh_token = await auth.authenticate()\r\n# add User authentication\r\nawait twitch.set_user_authentication(token, target_scope, refresh_token)\r\n```\r\n\r\nYou can reuse this token and use the refresh_token to renew it:\r\n\r\n```python\r\nfrom twitchAPI.oauth import refresh_access_token\r\nnew_token, new_refresh_token = await refresh_access_token('refresh_token', 'client_id', 'client_secret')\r\n```\r\n\r\n### AuthToken refresh callback\r\n\r\nOptionally you can set a callback for both user access token refresh and app access token refresh.\r\n\r\n```python\r\nfrom twitchAPI.twitch import Twitch\r\n\r\nasync def user_refresh(token: str, refresh_token: str):\r\n print(f'my new user token is: {token}')\r\n\r\nasync def app_refresh(token: str):\r\n print(f'my new app token is: {token}')\r\n\r\ntwitch = await Twitch('my_app_id', 'my_app_secret')\r\ntwitch.app_auth_refresh_callback = app_refresh\r\ntwitch.user_auth_refresh_callback = user_refresh\r\n```\r\n\r\n## EventSub\r\n\r\nEventSub lets you listen for events that happen on Twitch.\r\n\r\nThe EventSub client runs in its own thread, calling the given callback function whenever an event happens.\r\n\r\nThere are multiple EventSub transports available, used for different use cases.\r\n\r\nSee here for more info about EventSub in general and the different Transports, including code examples: [on readthedocs](https://pytwitchapi.readthedocs.io/en/stable/modules/twitchAPI.eventsub.html)\r\n\r\n\r\n\r\n## PubSub\r\n\r\nPubSub enables you to subscribe to a topic, for updates (e.g., when a user cheers in a channel).\r\n\r\nA more detailed documentation can be found [here on readthedocs](https://pytwitchapi.readthedocs.io/en/stable/modules/twitchAPI.pubsub.html)\r\n\r\n```python\r\nfrom twitchAPI.pubsub import PubSub\r\nfrom twitchAPI.twitch import Twitch\r\nfrom twitchAPI.helper import first\r\nfrom twitchAPI.type import AuthScope\r\nfrom twitchAPI.oauth import UserAuthenticator\r\nimport asyncio\r\nfrom pprint import pprint\r\nfrom uuid import UUID\r\n\r\nAPP_ID = 'my_app_id'\r\nAPP_SECRET = 'my_app_secret'\r\nUSER_SCOPE = [AuthScope.WHISPERS_READ]\r\nTARGET_CHANNEL = 'teekeks42'\r\n\r\nasync def callback_whisper(uuid: UUID, data: dict) -> None:\r\n print('got callback for UUID ' + str(uuid))\r\n pprint(data)\r\n\r\n\r\nasync def run_example():\r\n # setting up Authentication and getting your user id\r\n twitch = await Twitch(APP_ID, APP_SECRET)\r\n auth = UserAuthenticator(twitch, [AuthScope.WHISPERS_READ], force_verify=False)\r\n token, refresh_token = await auth.authenticate()\r\n # you can get your user auth token and user auth refresh token following the example in twitchAPI.oauth\r\n await twitch.set_user_authentication(token, [AuthScope.WHISPERS_READ], refresh_token)\r\n user = await first(twitch.get_users(logins=[TARGET_CHANNEL]))\r\n\r\n # starting up PubSub\r\n pubsub = PubSub(twitch)\r\n pubsub.start()\r\n # you can either start listening before or after you started pubsub.\r\n uuid = await pubsub.listen_whispers(user.id, callback_whisper)\r\n input('press ENTER to close...')\r\n # you do not need to unlisten to topics before stopping but you can listen and unlisten at any moment you want\r\n await pubsub.unlisten(uuid)\r\n pubsub.stop()\r\n await twitch.close()\r\n\r\nasyncio.run(run_example())\r\n```\r\n\r\n## Chat\r\n\r\nA simple twitch chat bot.\r\nChat bots can join channels, listen to chat and reply to messages, commands, subscriptions and many more.\r\n\r\nA more detailed documentation can be found [here on readthedocs](https://pytwitchapi.readthedocs.io/en/stable/modules/twitchAPI.chat.html)\r\n\r\n### Example code for a simple bot\r\n\r\n```python\r\nfrom twitchAPI.twitch import Twitch\r\nfrom twitchAPI.oauth import UserAuthenticator\r\nfrom twitchAPI.type import AuthScope, ChatEvent\r\nfrom twitchAPI.chat import Chat, EventData, ChatMessage, ChatSub, ChatCommand\r\nimport asyncio\r\n\r\nAPP_ID = 'my_app_id'\r\nAPP_SECRET = 'my_app_secret'\r\nUSER_SCOPE = [AuthScope.CHAT_READ, AuthScope.CHAT_EDIT]\r\nTARGET_CHANNEL = 'teekeks42'\r\n\r\n\r\n# this will be called when the event READY is triggered, which will be on bot start\r\nasync def on_ready(ready_event: EventData):\r\n print('Bot is ready for work, joining channels')\r\n # join our target channel, if you want to join multiple, either call join for each individually\r\n # or even better pass a list of channels as the argument\r\n await ready_event.chat.join_room(TARGET_CHANNEL)\r\n # you can do other bot initialization things in here\r\n\r\n\r\n# this will be called whenever a message in a channel was send by either the bot OR another user\r\nasync def on_message(msg: ChatMessage):\r\n print(f'in {msg.room.name}, {msg.user.name} said: {msg.text}')\r\n\r\n\r\n# this will be called whenever someone subscribes to a channel\r\nasync def on_sub(sub: ChatSub):\r\n print(f'New subscription in {sub.room.name}:\\\\n'\r\n f' Type: {sub.sub_plan}\\\\n'\r\n f' Message: {sub.sub_message}')\r\n\r\n\r\n# this will be called whenever the !reply command is issued\r\nasync def test_command(cmd: ChatCommand):\r\n if len(cmd.parameter) == 0:\r\n await cmd.reply('you did not tell me what to reply with')\r\n else:\r\n await cmd.reply(f'{cmd.user.name}: {cmd.parameter}')\r\n\r\n\r\n# this is where we set up the bot\r\nasync def run():\r\n # set up twitch api instance and add user authentication with some scopes\r\n twitch = await Twitch(APP_ID, APP_SECRET)\r\n auth = UserAuthenticator(twitch, USER_SCOPE)\r\n token, refresh_token = await auth.authenticate()\r\n await twitch.set_user_authentication(token, USER_SCOPE, refresh_token)\r\n\r\n # create chat instance\r\n chat = await Chat(twitch)\r\n\r\n # register the handlers for the events you want\r\n\r\n # listen to when the bot is done starting up and ready to join channels\r\n chat.register_event(ChatEvent.READY, on_ready)\r\n # listen to chat messages\r\n chat.register_event(ChatEvent.MESSAGE, on_message)\r\n # listen to channel subscriptions\r\n chat.register_event(ChatEvent.SUB, on_sub)\r\n # there are more events, you can view them all in this documentation\r\n\r\n # you can directly register commands and their handlers, this will register the !reply command\r\n chat.register_command('reply', test_command)\r\n\r\n\r\n # we are done with our setup, lets start this bot up!\r\n chat.start()\r\n\r\n # lets run till we press enter in the console\r\n try:\r\n input('press ENTER to stop\\n')\r\n finally:\r\n # now we can close the chat bot and the twitch api client\r\n chat.stop()\r\n await twitch.close()\r\n\r\n\r\n# lets run our setup\r\nasyncio.run(run())\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python 3.7+ implementation of the Twitch Helix API, PubSub, EventSub and Chat",
"version": "4.3.1",
"project_urls": {
"Homepage": "https://github.com/Teekeks/pyTwitchAPI"
},
"split_keywords": [
"twitch",
" twitch.tv",
" chat",
" bot",
" event sub",
" eventsub",
" pub sub",
" pubsub",
" helix",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e82965d93380e474398f516a4aaa0186aa955da32a82f3895c9f5863c5f2cbeb",
"md5": "e7eff4c55f10734665b3ee24650e0e67",
"sha256": "f97b0609e68552aa7c46953b5fe7c686580bd775c74a4bd59c36d7579f76e547"
},
"downloads": -1,
"filename": "twitchAPI-4.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e7eff4c55f10734665b3ee24650e0e67",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 119027,
"upload_time": "2024-09-15T02:14:45",
"upload_time_iso_8601": "2024-09-15T02:14:45.032887Z",
"url": "https://files.pythonhosted.org/packages/e8/29/65d93380e474398f516a4aaa0186aa955da32a82f3895c9f5863c5f2cbeb/twitchAPI-4.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eb322f7538599535610d7a28ddfde3545968f6d868e3c76afb2edda63a428bdd",
"md5": "c79f9188c04ab74c74f704d04ae5d495",
"sha256": "29f87014cce9e9352356f9ec5c4573bb397599cc2a9ba96d7c547063041163ee"
},
"downloads": -1,
"filename": "twitchapi-4.3.1.tar.gz",
"has_sig": false,
"md5_digest": "c79f9188c04ab74c74f704d04ae5d495",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 113648,
"upload_time": "2024-09-15T02:14:47",
"upload_time_iso_8601": "2024-09-15T02:14:47.973468Z",
"url": "https://files.pythonhosted.org/packages/eb/32/2f7538599535610d7a28ddfde3545968f6d868e3c76afb2edda63a428bdd/twitchapi-4.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-15 02:14:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Teekeks",
"github_project": "pyTwitchAPI",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "aiohttp",
"specs": [
[
">=",
"3.9.3"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
">=",
"2.8.2"
]
]
},
{
"name": "typing_extensions",
"specs": []
},
{
"name": "enum-tools",
"specs": []
}
],
"lcname": "twitchapi"
}
JSON
