{ "openapi": "3.0.1", "info": { "title": "Twitch Scraper — Channels, Streams, Clips & Top Games", "description": "Scrape Twitch channels (followers, live status, socials, emails), live streams, VODs, top clips, schedules, top categories and search. No login, no API key.", "version": "0.1", "x-build-id": "CWJhqs1WDPHktgRsb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~twitch-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-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/tortuga~twitch-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-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/tortuga~twitch-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-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", "videos", "clips", "liveStreams", "topCategories", "search", "schedule" ], "type": "string", "description": "channels = one profile per channel (followers, live status, current stream, socials, team). videos = VODs, highlights and uploads of the channels. clips = top clips of channels and/or categories. liveStreams = live streams of the categories, or of all Twitch. topCategories = games and categories ranked by viewers. search = channels or categories matching your terms. schedule = stream schedule of the channels.", "default": "channels" }, "channels": { "title": "Channels", "type": "array", "description": "Twitch channel names or URLs, e.g. shroud or https://www.twitch.tv/shroud. Used by the channels, videos, clips and schedule modes.", "items": { "type": "string" } }, "categories": { "title": "Categories / games", "type": "array", "description": "Category names, slugs or directory URLs, e.g. Just Chatting, league-of-legends or https://www.twitch.tv/directory/category/minecraft. Used by liveStreams (leave empty for all of Twitch) and clips (top clips of the category).", "items": { "type": "string" } }, "searchQueries": { "title": "Search terms", "type": "array", "description": "Terms to search for in search mode, e.g. minecraft or valorant. Results come in Twitch's relevance order; use Max items per source to keep only the best matches of each term.", "items": { "type": "string" } }, "searchType": { "title": "Search for", "enum": [ "channels", "categories" ], "type": "string", "description": "Search mode: find channels (output as full channel profiles) or categories.", "default": "channels" }, "videoType": { "title": "Video type", "enum": [ "all", "archive", "highlight", "upload" ], "type": "string", "description": "Videos mode: past broadcasts (archive), highlights, uploads, or all of them.", "default": "all" }, "videoSort": { "title": "Video order", "enum": [ "newest", "views" ], "type": "string", "description": "Videos mode: newest first or most viewed first.", "default": "newest" }, "clipPeriod": { "title": "Clips from the last", "enum": [ "24h", "7d", "30d", "all" ], "type": "string", "description": "Clips mode: top clips (by views) created in this period.", "default": "7d" }, "streamTags": { "title": "Stream tags", "type": "array", "description": "liveStreams mode: only streams with these Twitch tags, e.g. English, Deutsch, Español or DropsEnabled (Twitch's own tag filter).", "items": { "type": "string" } }, "maxItemsPerSource": { "title": "Max items per source", "minimum": 1, "type": "integer", "description": "Limit for each channel, category or search term (e.g. the 20 newest videos of each channel, or the top 50 streams of each category). Leave empty to use only Max items." }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many results in total. You pay per result, so this caps the cost.", "default": 100 }, "onlyNewOrChanged": { "title": "Only new or changed items", "type": "boolean", "description": "Remember what earlier runs of this input returned and output only new items (new videos, clips, streams, channels) or items whose watched fields changed (channels: live status, stream title, category; schedules: time, title, cancellation). Use with a Schedule; unchanged items are not charged.", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name for this watch, so several schedules on the same input stay separate; defaults to a key derived from the input." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy (the default) works: Twitch's API does not block it. Residential proxy is not needed.", "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 }, "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 } } } } } } } } } }