{ "openapi": "3.0.1", "info": { "title": "Twitch Streams & Channels Scraper", "description": "Export public Twitch streams, channels, categories, viewer metrics, account details, recent videos, and top clips through the official Twitch API.", "version": "0.4", "x-build-id": "PHXMISfFaQbqvJx7c" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetch_cat~twitch-streams-channels-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetch_cat-twitch-streams-channels-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/fetch_cat~twitch-streams-channels-scraper/runs": { "post": { "operationId": "runs-sync-fetch_cat-twitch-streams-channels-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/fetch_cat~twitch-streams-channels-scraper/run-sync": { "post": { "operationId": "run-sync-fetch_cat-twitch-streams-channels-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": { "startUrls": { "title": "Twitch channel, category, or search URLs", "maxItems": 100, "type": "array", "description": "Paste public Twitch channel URLs, category URLs, or search URLs. Up to 100 URLs per run.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "categories": { "title": "Twitch categories or games", "maxItems": 100, "type": "array", "description": "Enter up to 100 Twitch category names, such as Just Chatting, Minecraft, or League of Legends. The closest documented category match is used when an exact match is unavailable.", "items": { "type": "string" } }, "searchTerms": { "title": "Channel search terms", "maxItems": 100, "type": "array", "description": "Enter up to 100 terms for finding live and offline public Twitch channels.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum saved channels", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of unique stream or channel rows saved across every input and page.", "default": 20 }, "includeVideos": { "title": "Include recent public VODs", "type": "boolean", "description": "Add recent public archived broadcasts to each enriched channel row. Disabled by default to minimize requests and runtime.", "default": false }, "videosPerChannel": { "title": "VODs per channel", "minimum": 1, "maximum": 5, "type": "integer", "description": "Number of recent public archived broadcasts to attach when VOD enrichment is enabled.", "default": 3 }, "includeOfflineChannels": { "title": "Include offline channels", "type": "boolean", "description": "Include offline profiles found through channel URLs and channel search. Category and top-stream results are live only.", "default": true }, "includeClips": { "title": "Include top public clips", "type": "boolean", "description": "Add top public clips to each enriched channel row. Disabled by default to minimize requests and runtime.", "default": false }, "clipsPerChannel": { "title": "Clips per channel", "minimum": 1, "maximum": 5, "type": "integer", "description": "Number of top public clips to attach when clip enrichment is enabled.", "default": 3 }, "includeSchedule": { "title": "Include upcoming public schedule", "type": "boolean", "description": "Attach upcoming public stream-schedule segments to selected channel rows. Disabled by default to minimize requests and runtime.", "default": false }, "scheduleSegmentsPerChannel": { "title": "Schedule segments per channel", "minimum": 1, "maximum": 25, "type": "integer", "description": "Number of upcoming public schedule segments to attach when schedule enrichment is enabled.", "default": 5 }, "maxEnrichedChannels": { "title": "Maximum enriched channels", "minimum": 1, "maximum": 100, "type": "integer", "description": "Caps the number of channels that receive VOD, clip, or schedule requests. Base channel rows continue after this limit.", "default": 20 }, "allowEmptyResults": { "title": "Legacy empty-results setting", "type": "boolean", "description": "Retained for saved-task/API compatibility. Genuine completed no-match results now succeed with an empty dataset regardless of this value. Blocking, extraction failures and incomplete requested work still fail while preserving saved rows.", "default": false }, "maxRunSeconds": { "title": "Active work deadline", "minimum": 60, "maximum": 270, "type": "integer", "description": "Maximum seconds spent admitting Twitch work. The Actor stops earlier when needed to reserve at least 30 seconds for persistence and cleanup.", "default": 240 }, "connectionMode": { "title": "Connection", "enum": [ "direct", "automatic" ], "type": "string", "description": "Direct sends Twitch requests without a proxy and never falls back to paid proxy traffic. Automatic uses the existing SDK-managed proxy route from the first request, not direct-first fallback. The form starts with Direct, preserving its previous prefill. API or saved-task input omitting both connection settings preserves the existing managed-proxy behavior. Explicit proxyConfiguration always wins, even over a conflicting connection selection. Managed proxy usage may incur platform charges." }, "proxyConfiguration": { "title": "Existing or custom proxy settings", "type": "object", "description": "Optional advanced override for existing managed groups/countries, customer proxy pools or an explicit useApifyProxy=false opt-out. Overrides Connection whenever supplied. Existing saved tasks and API configurations continue unchanged. Omit this override to use Connection. The selected route is used for all Twitch requests, with no additional fallback route." } } }, "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 } } } } } } } } } }