Use Twitch Live Stream, Channel & VOD Metadata Extractor with Python

Get Twitch top live streams, channel profiles, category directories, VOD metadata and clip details, or resolve any twitch.tv URL into structured data.

1. Choose the data you need

Review the published README for supported collection modes, examples, and limits. The recipe below uses the current published input definition.

2. Prepare a source-based input

This JSON contains published prefills and required-field defaults. Review every value for your task before running it; it is not a promise of successful collection.

{
  "channelNames": [],
  "clipPeriod": "LAST_WEEK",
  "clipSlugs": [],
  "clipSort": "VIEWS_DESC",
  "includeChannelClips": true,
  "includeChannelVideos": true,
  "language": "EN",
  "maxItems": 3,
  "mode": "topStreams",
  "onlyLive": false,
  "searchQuery": "lirik",
  "searchType": "all",
  "streamSort": "VIEWER_COUNT",
  "streamTags": [],
  "streamType": "",
  "twitchUrls": [],
  "videoIds": [],
  "videoSort": "TIME"
}

Download input.example.json and save your reviewed copy as input.json.

Field	Type	Required	Description
`mode`	string	required	What to fetch.
`searchQuery`	string	optional	Free-text query for `mode=search` — matches channels, categories, and videos.
`searchType`	string	optional	Restrict search results to one index. `all` returns channels, categories, and videos.
`channelName`	string	optional	Twitch channel login or channel URL, e.g. `lirik` or `https://www.twitch.tv/lirik`.
`channelNames`	array	optional	Batch channel logins or channel URLs. Duplicates and the single `channelName` are merged.
`categorySlug`	string	optional	Category slug (`just-chatting`), exact name (`Just Chatting`), or directory URL.
`videoId`	string	optional	Twitch VOD ID or VOD URL, e.g. `2766365638`.
`videoIds`	array	optional	Batch VOD IDs or VOD URLs. Duplicates and the single `videoId` are merged.
`clipSlug`	string	optional	Twitch clip slug or clip URL, e.g. `AcceptablePleasantAuberginePanicVis-EVdxDQ1vsQAQZpBS`.
`clipSlugs`	array	optional	Batch clip slugs or clip URLs. Duplicates and the single `clipSlug` are merged.
`twitchUrls`	array	optional	Channel, VOD, clip, or category URLs. Category and channel `/videos` and `/clips` tabs are supported.
`language`	string	optional	Filter live streams, VODs, and clips to one broadcast language. Leave on `(any)` for no filter.
`streamSort`	string	optional	Sort live streams by viewers (high to low or low to high), recently started, or recommended.
`streamTags`	array	optional	Only live streams carrying all of these freeform tags, e.g. `English`, `DropsEnabled`, `NoBackseating`.
`streamType`	string	optional	Restrict channel or category VODs to one broadcast type. Leave blank for all types.
`videoSort`	string	optional	Sort channel or category VODs by publish time or view count.
`clipPeriod`	string	optional	Time window over which clips were created.
`clipSort`	string	optional	Sort clips by views or trending score.
`includeChannelClips`	boolean	optional	Also fetch and emit top clips for each channel.
`includeChannelVideos`	boolean	optional	Also fetch and emit recent VODs for each channel.
`minViewersCount`	integer	optional	Drop live streams (and categories) below this viewer count.
`minViewCount`	integer	optional	Drop VODs and clips below this total view count.
`minFollowersCount`	integer	optional	Drop channels and live streams below this follower count. VODs and clips are unaffected.
`maxFollowersCount`	integer	optional	Drop channels and live streams above this follower count. Useful for finding smaller creators.
`onlyLive`	boolean	optional	Drop channel profile records for channels that are not live right now. Their VODs and clips are still returned.
`containsKeyword`	string	optional	Case-insensitive substring filter on stream, VOD, and clip titles.
`maxItems`	integer	optional	Hard cap on emitted records. Twitch source caps still apply (e.g. about 1,000 clips per category).

3. Start an Actor run

Set APIFY_TOKEN in your environment. Python 3.10 or newer is sufficient; this recipe uses no third-party packages.

Execution may incur charges. Review current pricing on Apify. The request asks for a 120-second timeout and a charge limit; these settings are subject to Apify’s pricing and do not guarantee an all-inclusive spending cap.

import json
import os
import urllib.request

# Save the schema-derived example as input.json; review and edit it first.
with open("input.json", encoding="utf-8") as stream:
    actor_input = json.load(stream)

token = os.environ["APIFY_TOKEN"]
request = urllib.request.Request(
    "https://api.apify.com/v2/acts/awepzbjt4Zv29dF9p/runs?timeout=120&maxTotalChargeUsd=0.50",
    data=json.dumps(actor_input).encode("utf-8"),
    headers={"Authorization": "Bearer " + token, "Content-Type": "application/json"},
    method="POST",
)
# This starts a potentially billable run. Do not automatically retry this POST.
with urllib.request.urlopen(request, timeout=40) as response:
    run = json.load(response)["data"]
print("Run ID:", run["id"])
print("Status:", run["status"])
# Inspect and download results in Apify Console once the run succeeds.

4. Inspect the actual results

Open the run in Apify Console and wait for a successful completion. Use the published output schema to locate results and the dataset schema to understand declared views. Missing or optional record fields must not be treated as guaranteed values.

Twitch records — live streams, channels, videos (VODs), clips, and games (categories) with viewers, followers, durations, thumbnails, broadcaster details, socials, schedules, and direct URLs.

Questions before you run

Which inputs are required?

The published required fields are mode

What does this guide verify?

The fields, prefills, and schema links are rendered from the published build. This is a usage recipe, not a paid live extraction test. Source availability and collection results can vary.

What if the run request times out?

Check Apify Console before retrying. The first request may already have created a run. Do not automatically repeat a run-creation POST.

Open on Apify Full Actor reference

Generated from source build LulWkQbhoV6gIZUhD and its README and schemas. Source changes regenerate this guide; no third-party editorial claims are inferred.