Search through all livestreams on Twitch
This project can host a FastAPI server with that you can search through all streams currently live on Twitch.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
python3
is required.
uvicorn[standard]
is required.
Install the required packages and uvicorn by running:
pip install -r requirements.txt
pip install uvicorn[standard]
After that copy the example Environment variables to use them:
cp .env.example .env
Now you need to fill in the missing values in the .env
file.
Only one endpoint is available which is at /search
.
You can filter the streams by title
.
There are automatically generated docs at http://localhost:8000/docs or https://tts-de-gta5.nickwasused.com/docs
A Dockerfile is available at ./Dockerfile
The default listening Port is 8000
.
There is a default instance available at https://tts-de-gta5.nickwasused.com/docs. This instance is filtering for german streams playing Grand Theft Auto V. https://uptime.nickwasused.com/status/tss
The code is formatted and checked with ruffs default settings.
I am not affiliated with Twitch Interactive, Inc.