{ "openapi": "3.0.1", "info": { "title": "Twitch Scraper — Channels, Live Streams, VODs & Clips", "description": "Scrape public Twitch data without login or API key: channel profiles (followers, partner status, live now, last and next stream, social links), live streams by category, language or tag, past broadcasts, highlights, clips and top categories. From US$1.60 per 1,000 results.", "version": "0.1", "x-build-id": "iiC6csRFK019DXo7R" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fabrikit~twitch-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fabrikit-twitch-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/fabrikit~twitch-scraper/runs": { "post": { "operationId": "runs-sync-fabrikit-twitch-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/fabrikit~twitch-scraper/run-sync": { "post": { "operationId": "run-sync-fabrikit-twitch-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "mode": { "title": "What to scrape", "enum": [ "channels", "liveStreams", "videos", "clips", "categories" ], "type": "string", "description": "channels = one profile row per channel (followers, partner/affiliate, live now, last and next stream, social links). liveStreams = streams live right now (top of Twitch, of a category, or of the channels you list). videos = past broadcasts, highlights and uploads of the channels. clips = most viewed clips of channels or categories in a period. categories = categories (games) with live viewers and channels.", "default": "channels" }, "channels": { "title": "Channels", "type": "array", "description": "One per line: a login (shroud), a channel URL (https://www.twitch.tv/shroud), a video URL (https://www.twitch.tv/videos/123, videos mode) or a clip URL (https://clips.twitch.tv/... or twitch.tv//clip/..., clips mode). Not used in categories mode.", "items": { "type": "string" } }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "Keywords for Twitch search. channels / videos / clips modes: the channels Twitch finds for each keyword (up to 'Results per source') are scraped. categories mode: categories matching the keyword. Not used for live streams.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Category (game) names, slugs or directory URLs: Just Chatting, valorant, https://www.twitch.tv/directory/category/minecraft. liveStreams mode: top live streams of each category. clips mode: top clips of each category. channels mode: profiles of the channels live in the category right now. categories mode: one row per category. Without any category, liveStreams and categories modes list the top of all of Twitch.", "items": { "type": "string" } }, "languages": { "title": "Stream languages", "type": "array", "description": "Only streams (and category clips) in these broadcaster languages. Empty = all languages.", "items": { "type": "string", "enum": [ "EN", "ES", "PT", "DE", "FR", "IT", "RU", "JA", "KO", "ZH", "ZH_HK", "TR", "PL", "NL", "SV", "NO", "DA", "FI", "CS", "SK", "HU", "RO", "BG", "EL", "UK", "AR", "HI", "ID", "MS", "TH", "TL", "VI", "CA", "ASL", "OTHER" ], "enumTitles": [ "English", "Spanish", "Portuguese", "German", "French", "Italian", "Russian", "Japanese", "Korean", "Chinese", "Chinese (Hong Kong)", "Turkish", "Polish", "Dutch", "Swedish", "Norwegian", "Danish", "Finnish", "Czech", "Slovak", "Hungarian", "Romanian", "Bulgarian", "Greek", "Ukrainian", "Arabic", "Hindi", "Indonesian", "Malay", "Thai", "Tagalog", "Vietnamese", "Catalan", "American Sign Language", "Other" ] } }, "tags": { "title": "Stream tags", "type": "array", "description": "Only live streams carrying all of these tags (as shown under the stream, e.g. Español, English, DropsEnabled). Live streams and channels found through categories only.", "items": { "type": "string" } }, "maxResultsPerSource": { "title": "Results per source", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum results taken from each channel, category, keyword or top list. 0 = no limit (only maxItems).", "default": 30 }, "maxItems": { "title": "Maximum rows", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many rows in total. Exact: the run never saves or charges more.", "default": 100 }, "videoType": { "title": "Video type (videos mode)", "enum": [ "all", "archive", "highlight", "upload" ], "type": "string", "description": "Past broadcasts (archive), highlights, uploads, or all of them.", "default": "all" }, "videoSort": { "title": "Video order (videos mode)", "enum": [ "time", "views" ], "type": "string", "description": "Newest first or most viewed first.", "default": "time" }, "clipPeriod": { "title": "Clip period (clips mode)", "enum": [ "day", "week", "month", "all" ], "type": "string", "description": "Clips created in this period, most viewed first.", "default": "week" }, "minFollowers": { "title": "Minimum followers (channels mode)", "minimum": 0, "type": "integer", "description": "Skip channels with fewer followers. 0 = no minimum.", "default": 0 }, "minViewers": { "title": "Minimum live viewers (liveStreams mode)", "minimum": 0, "type": "integer", "description": "Skip live streams with fewer current viewers. 0 = no minimum.", "default": 0 }, "maxConcurrency": { "title": "Parallel sources", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many channels or categories are read at the same time.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed normally: Twitch's public endpoint answers direct requests. Set a proxy only if your runs get blocked.", "default": { "useApifyProxy": false } }, "autoProxyFallback": { "title": "Switch to Apify proxies when blocked", "type": "boolean", "description": "If Twitch blocks two requests in a row, continue through Apify datacenter proxies and then residential proxies.", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }