Skip to content

DmitryScaletta/twitch-api-swagger

Repository files navigation

twitch-api-swagger

Unofficial Swagger UI for Twitch API.

https://twitch-api-swagger.surge.sh - classic swagger ui
https://twitch-api-swagger.surge.sh/scalar/ - scalar ui

All endpoints are generated automatically from the twitch docs page.

Features:

  • Swagger UI for all Twitch API endpoints
  • Schemas for Request Query Parameters, Request Body, Response Body
  • Some additional schemas like Clip, ChatBadge, Prediction, Game, Channel, Video etc.
  • Response codes and examples
  • Generated types for TypeScript: ts-twitch-api

Code Generation

TypeScript

Generate typescript interfaces:

npx openapi-typescript https://twitch-api-swagger.surge.sh/openapi.json -o src/twitch-api.generated.ts

Or see ts-twitch-api package with all typescript interfaces and simple TwitchApi class for all endpoints.