{ "openapi": "3.0.1", "info": { "title": "Twitch Channels & Streams Scraper", "description": "Twitch Channels & Streams Scraper SD - Twitch Channels & Streams Scraper is a logged-out tool that extracts Twitch channel profiles, channel search, live streams, top games, category search, clips and VODs: followers, live status, viewers, titles, games, social links. No API key.", "version": "1.0", "x-build-id": "EvPW5OaOfhCFVyUBj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neuro-scraper~twitch-channels-streams-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neuro-scraper-twitch-channels-streams-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/neuro-scraper~twitch-channels-streams-scraper/runs": { "post": { "operationId": "runs-sync-neuro-scraper-twitch-channels-streams-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/neuro-scraper~twitch-channels-streams-scraper/run-sync": { "post": { "operationId": "run-sync-neuro-scraper-twitch-channels-streams-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", "searchChannels", "topStreams", "gameStreams", "topGames", "searchGames", "clips", "videos" ], "type": "string", "description": "channels = one profile row per channel in 'Channel usernames' (followers, live status, last broadcast, social links, optional recent VODs and top clips); searchChannels = channels matching 'Search query'; topStreams = the most-watched live streams on Twitch; gameStreams = live streams of the category in 'Game / category name'; topGames = the most-watched categories; searchGames = categories matching 'Search query'; clips / videos = clips or VODs of each channel in 'Channel usernames' (or of the category in 'Game / category name').", "default": "channels" }, "channelUsernames": { "title": "Channel usernames", "type": "array", "description": "Twitch channels, one per line: a login (shroud), @login or channel URL (https://www.twitch.tv/pokimane). Used by the modes channels, clips and videos.", "items": { "type": "string" } }, "searchQuery": { "title": "Search query", "type": "array", "description": "Keywords for searchChannels / searchGames, one search per line (e.g. speedrun). Twitch's own search, followed page by page (30 per page) up to Max items per query.", "items": { "type": "string" } }, "gameName": { "title": "Game / category name", "type": "string", "description": "For gameStreams (and clips / videos when no channel is given): the exact category name (Just Chatting, VALORANT) or its directory URL (https://www.twitch.tv/directory/category/just-chatting)." }, "maxItems": { "title": "Max items (per channel / search / category)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum rows per search query, category or channel list. Searches follow Twitch's cursor 30 per page; other lists are limited by what Twitch shows logged out (see the log).", "default": 30 }, "includeVideos": { "title": "Include recent videos (channels mode)", "type": "boolean", "description": "Add 'recentVideos' (id, title, views, duration, date, game, thumbnail) to each channel row.", "default": true }, "includeClips": { "title": "Include top clips (channels mode)", "type": "boolean", "description": "Add 'topClips' (title, views, duration, clipper, URL) of the clip period below to each channel row.", "default": false }, "videosPerChannel": { "title": "Max videos / clips per channel row", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many recent videos and top clips go into each channel row (channels mode). Twitch shows up to 100 logged out.", "default": 10 }, "clipsPeriod": { "title": "Clips time period", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_MONTH", "ALL_TIME" ], "type": "string", "description": "Period for clips (clips mode and topClips).", "default": "LAST_WEEK" }, "clipsSort": { "title": "Clips sort order", "enum": [ "VIEWS_DESC", "TRENDING" ], "type": "string", "description": "Most viewed or trending (Twitch's own clip sorts).", "default": "VIEWS_DESC" }, "videoType": { "title": "Video type", "enum": [ "ALL", "ARCHIVE", "HIGHLIGHT", "UPLOAD" ], "type": "string", "description": "Which VODs (videos mode and recentVideos).", "default": "ALL" }, "videoSort": { "title": "Video sort order", "enum": [ "TIME", "VIEWS" ], "type": "string", "description": "Most recent or most viewed.", "default": "TIME" }, "streamSort": { "title": "Stream sort (gameStreams)", "enum": [ "VIEWER_COUNT", "VIEWER_COUNT_ASC", "RECENT", "RELEVANCE" ], "type": "string", "description": "Order of a category's live streams. When Max items is above one page, the other orders are also read and merged (deduplicated) to reach more streams.", "default": "VIEWER_COUNT" }, "languages": { "title": "Stream languages (gameStreams)", "type": "array", "description": "Optional. Only streams in these broadcaster languages, two-letter codes (EN, DE, ES, JA ...).", "items": { "type": "string" } }, "minViewers": { "title": "Minimum viewers", "minimum": 0, "type": "integer", "description": "Optional. topStreams / gameStreams: drop live streams with fewer current viewers (applied to the rows Twitch returns).", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify residential proxies are the default. Twitch's web API answers from any country.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }