{ "openapi": "3.0.1", "info": { "title": "Twitch Scraper: Channels, Streams, Clips & Games", "description": "Scrape Twitch channel profiles, live streams, top games, clips, and videos. No login, no API key. Covers channel lookup, channel search, top live streams, per-game streams, top games, clips, and VODs.", "version": "0.1", "x-build-id": "xJrWpTeVU8Kz6E4G4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~twitch-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-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/getascraper~twitch-scraper/runs": { "post": { "operationId": "runs-sync-getascraper-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/getascraper~twitch-scraper/run-sync": { "post": { "operationId": "run-sync-getascraper-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": "Scrape mode", "enum": [ "channels", "searchChannels", "topStreams", "gameStreams", "topGames", "clips", "videos" ], "type": "string", "description": "What to scrape. 'Channels' looks up specific channels by login or URL. 'Search channels' finds channels matching a search phrase. 'Top live streams' returns the sitewide live directory. 'Streams by game' returns live streams for specific games. 'Top games' returns the sitewide game directory. 'Clips' and 'Videos' return a channel's clips or VODs.", "default": "channels" }, "targets": { "title": "Targets", "type": "array", "description": "What to look up. Channels/Clips/Videos: channel logins or twitch.tv URLs (e.g. \"shroud\" or \"https://www.twitch.tv/shroud\"). Search channels: search phrases (e.g. \"speedrun\"). Streams by game: game or category names (e.g. \"VALORANT\"). Not used by Top live streams or Top games.", "items": { "type": "string" } }, "clipPeriod": { "title": "Clip period", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_MONTH", "ALL_TIME" ], "type": "string", "description": "Time window for ranking clips by views. Used by Clips mode, and by the 'Include top clips' enrichment on Channels mode.", "default": "ALL_TIME" }, "includeRecentVideos": { "title": "Include recent videos", "type": "boolean", "description": "Attach each channel's most recent videos (VODs) as a nested list on the channel row. Channels mode only.", "default": false }, "recentVideosLimit": { "title": "Recent videos limit", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many recent videos to attach per channel, when enabled above.", "default": 5 }, "includeTopClips": { "title": "Include top clips", "type": "boolean", "description": "Attach each channel's top clips (ranked by views over the clip period above) as a nested list on the channel row. Channels mode only.", "default": false }, "topClipsLimit": { "title": "Top clips limit", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many top clips to attach per channel, when enabled above.", "default": 5 }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of records to return. Twitch caps a single request at 30 for Top live streams and 100 for Streams by game / Top games / Clips / Videos, so higher values are trimmed to that cap. Channels and Search channels return up to one row (or one page of matches) per target regardless of this value.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Twitch's public data feed has no anti-bot defenses, so a plain datacenter proxy is enough. Residential is not required.", "default": { "useApifyProxy": 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 } } }, "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 } } } } } } } } } }