{ "openapi": "3.0.1", "info": { "title": "Twitch Scraper - Streams, Clips, VODs & Channel Data", "description": "From $1/1K. Scrape Twitch data at scale, including channels, live streams, clips, VODs, and top games. Extract HLS m3u8 stream URLs, clip MP4 downloads in multiple qualities, chapter markers, and metadata. Supports keyword search with rich, analytics-ready output.", "version": "1.0", "x-build-id": "02fOjNnGcvHYbwvxk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~twitch-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-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/abotapi~twitch-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-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/abotapi~twitch-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "channel", "live_streams", "game_streams", "top_games", "search", "clips", "videos", "vod_metadata", "vod_comments", "url" ], "type": "string", "description": "What to scrape. Each mode reads only the inputs in its own section below. Mode precedence: the selected mode alone decides what runs; inputs in other mode sections are ignored, and URL mode reads only urls.", "default": "channel" }, "channels": { "title": "Channel logins", "type": "array", "description": "Twitch usernames (the part after twitch.tv/) or pasted channel URLs, one per line. Example: shroud, ninja, https://www.twitch.tv/pokimane. Defaults to shroud so a bare API call in channel mode returns data.", "default": [ "shroud" ], "items": { "type": "string" } }, "clipPeriod": { "title": "Clips period (clips mode)", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_MONTH", "ALL_TIME" ], "type": "string", "description": "Time window for clips collection.", "default": "LAST_WEEK" }, "gameSlug": { "title": "Game slug", "type": "string", "description": "Category slug (from twitch.tv/directory/category/SLUG) or the category name, e.g. valorant, just-chatting or 'Just Chatting'. A name that matches no category fails the run with a clear message." }, "streamSort": { "title": "Stream sort", "enum": [ "VIEWER_COUNT", "RECENT", "RELEVANCE" ], "type": "string", "description": "Sort order for the live stream list.", "default": "VIEWER_COUNT" }, "searchQuery": { "title": "Search query", "type": "string", "description": "Free-text keyword." }, "keywords": { "title": "Keywords (multi-query search)", "type": "array", "description": "Search mode: run several queries in one run. Combined with Search query. Each keyword tags its rows in the `keyword` output field. The Max results limit applies to each keyword, so a run can return up to keywords x Max results records.", "items": { "type": "string" } }, "videoIds": { "title": "Video IDs", "type": "array", "description": "Numeric video IDs (the trailing segment of a twitch.tv/videos/ID URL), one per line. Example: 2767213751.", "items": { "type": "string" } }, "urls": { "title": "URLs", "type": "array", "description": "Paste any twitch.tv URLs, one per line. Mixing kinds is fine. Left untouched, 10 example URLs cover every supported URL shape (the channel-path clip form is the same as the clips.twitch.tv form): Max results is split evenly across the URLs (at least 1 each while the total allows; the run still stops at Max results, so set it to at least the number of URLs to cover every URL).", "default": [ "https://www.twitch.tv/shroud", "https://www.twitch.tv/directory/category/just-chatting", "https://www.twitch.tv/directory/game/Valorant", "https://www.twitch.tv/videos/2767213751", "https://clips.twitch.tv/TangentialBillowingJalapenoYee-ccA2oB1pEYh4CHWJ", "https://m.twitch.tv/ninja", "https://www.twitch.tv/shroud/videos", "https://www.twitch.tv/shroud/clips", "https://www.twitch.tv/search?term=valorant", "https://www.twitch.tv/directory" ], "items": { "type": "string" } }, "includeMediaUrls": { "title": "Include playable media URLs", "type": "boolean", "description": "When true, each live stream record carries an HLS m3u8 URL and each VOD carries an HLS playlist. Adds ~1 extra request per live-stream record (other modes incur negligible extra cost). Clip MP4 URLs are always included at no extra charge.", "default": true }, "maxResults": { "title": "Max results", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum records to return. 0 = the hard cap of 100000 (still capped by maxPages). In search mode with several keywords the limit applies to each keyword, so a run can return up to keywords x Max results records. In url mode it is split evenly across the URLs, at least 1 each while the total allows.", "default": 30 }, "maxItems": { "title": "Max items (alias of Max results)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Alias of Max results; takes precedence when set (hard cap 100000). 0 or empty = use Max results. In search mode with several keywords it applies to each keyword, so a run can return up to keywords x Max results records." }, "maxPages": { "title": "Max pages", "minimum": 0, "type": "integer", "description": "Pages to walk for paginated modes (~30 items per page). 0 = walk until the source is exhausted or maxResults is hit, with a hard cap of 1000 pages.", "default": 0 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Datacenter works for this site and is the default. If the selected connection is unavailable, the actor falls back to a backup connection automatically.", "default": { "useApifyProxy": true } }, "resumeFromRunId": { "title": "Resume from a previous run", "type": "string", "description": "Paste a previous run ID or dataset ID to continue a large pull without returning or charging for records already collected there. Use this after an interrupted run, or when continuing a large crawl in another run. For recurring monitoring of the same mode+filters, use Incremental mode below instead." }, "incrementalMode": { "title": "Incremental changes for scheduled runs", "type": "boolean", "description": "Turn this on for daily or recurring monitoring. The first run returns all matching records as NEW. Later runs normally return only NEW, UPDATED, and REAPPEARED records. A record is UPDATED when any content field changes (title, game, status, tags, etc.). Live counters (viewersCount, viewCount, followersCount), rotating thumbnail URLs, signed clip media URLs, HLS playlist URLs and scrapedAt are never compared and never listed in changedFields, but stay in the output. Add more with \"Ignore fields when detecting changes\". Turn on \"Emit unchanged\" or \"Emit expired\" only when you also want those records returned (and billed). State is kept separately for each mode+filters setup; use State key when you want to name or deliberately share a monitoring campaign. To continue one specific interrupted run instead, use Resume from a previous run above.", "default": false }, "stateKey": { "title": "State key (optional, incremental mode only)", "type": "string", "description": "Optional. Name this monitoring campaign to keep its state stable, or to deliberately share state across differently-configured runs. Leave empty to let the actor derive a key automatically from the mode and its filters — different searches then never mix state with each other." }, "emitUnchanged": { "title": "Emit unchanged records (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return records that have not changed since the last run, marked UNCHANGED. This returns — and bills — extra rows you already have, so leave it off unless you specifically want the full snapshot every run.", "default": false }, "emitExpired": { "title": "Emit expired records (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return records that were present in a previous run but are no longer found, marked EXPIRED. Only produced once a run has fully scanned the tracked scope — not when Max results/Max pages capped it, when Resume was used, or when a channel/game has more clips or videos than this run's per-target budget. This returns — and bills — extra synthetic rows, so leave it off unless you need expiry tracking.", "default": false }, "ignoreFieldsForChanges": { "title": "Ignore fields when detecting changes (incremental mode only)", "type": "array", "description": "Incremental mode only. Field names (or dotted paths such as stream.title) that are NOT compared when deciding whether a record changed; they stay in the output but never make a record UPDATED or appear in changedFields. Counters, thumbnails, signed media URLs and scrapedAt are already ignored.", "default": [], "items": { "type": "string" } }, "mcpConnectors": { "title": "Pipe results into your apps (optional)", "type": "array", "description": "Optionally send the scraped results into the apps you already use, via Model Context Protocol (MCP) connectors. Authorize a connector once under Apify → Settings → Integrations, then select it here. The connector receives a condensed, human-readable summary per item (title + key fields), not the full JSON — the complete record stays in the dataset. Leave empty to skip. Supported: Notion (https://mcp.notion.com/mcp), Linear (https://mcp.linear.app/sse), Airtable (https://mcp.airtable.com/mcp), Apify (https://mcp.apify.com)." }, "notionParentPageUrl": { "title": "Notion parent page (Notion connector only)", "type": "string", "description": "URL (or id) of the Notion page under which item pages are created. Required to enable the Notion export; ignored by other connectors." }, "maxNotifyListings": { "title": "Max items to export per connector", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on items written to each connector per run. Does not affect the dataset.", "default": 50 } } }, "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 } } } } } } } } } }