{ "openapi": "3.0.1", "info": { "title": "Twitch Streams Scraper", "description": "Collect Twitch live streams, top categories, or channel profiles and return viewer counts, titles, language, followers, category details, and tags. Live stream queries can fan out across categories and languages; each query returns up to 30 streams, without requiring a Twitch login or OAuth token.", "version": "0.1", "x-build-id": "DeMyFWe2WWiB0xGzg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiomworks~twitch-streams-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiomworks-twitch-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/axiomworks~twitch-streams-scraper/runs": { "post": { "operationId": "runs-sync-axiomworks-twitch-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/axiomworks~twitch-streams-scraper/run-sync": { "post": { "operationId": "run-sync-axiomworks-twitch-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": { "categories": { "title": "Categories", "type": "array", "description": "liveStreams only. Category slugs, names or twitch.tv/directory/category URLs, e.g. ['valorant', 'League of Legends', 'https://www.twitch.tv/directory/category/just-chatting']. Empty = site-wide top streams. Unknown categories are skipped with a warning.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "liveStreams", "topCategories", "channels" ], "type": "string", "description": "What to collect. 'liveStreams' = current live streams (uses categories, languages, filters); 'topCategories' = top categories by viewers (max 100); 'channels' = channel profiles (requires 'channels'). Example: 'liveStreams'. Default 'liveStreams'.", "default": "liveStreams" }, "languages": { "title": "Languages", "type": "array", "description": "liveStreams only. Twitch language codes, e.g. ['EN', 'ES', 'PT', 'JA', 'KO']. One query (max 30 streams) per category and language. Empty = all languages. Invalid codes fail the run.", "items": { "type": "string" }, "default": [] }, "channels": { "title": "Channels", "type": "array", "description": "channels mode only (required there). Channel logins or twitch.tv URLs, e.g. ['shroud', 'https://www.twitch.tv/ninja']. Unknown channels are skipped.", "items": { "type": "string" }, "default": [] }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum records to output, integer 1-1000, default 50. Twitch returns at most 30 streams per category and language query and 100 categories, so the real total is bounded by that. Example: 20.", "default": 50 }, "minViewers": { "title": "Minimum viewers", "minimum": 0, "type": "integer", "description": "liveStreams only. Keep streams with at least this many current viewers, integer >= 0, e.g. 100. Default 0. Applies within the first 30 streams per category and language.", "default": 0 }, "maxViewers": { "title": "Maximum viewers", "minimum": 0, "type": "integer", "description": "liveStreams only. Keep streams with at most this many current viewers, integer >= minViewers, e.g. 500. Omit for no upper bound." }, "titleContains": { "title": "Title contains", "type": "string", "description": "liveStreams only. Keep streams whose title contains this text, case-insensitive, e.g. 'tournament'. Default empty = all titles.", "default": "" }, "topCategoriesToScan": { "title": "Top categories to scan", "minimum": 0, "maximum": 100, "type": "integer", "description": "When categories is empty, scan the top 1-100 categories by viewers for live streams, up to 30 per category and language. Set 0 (default) for only the site-wide top streams.", "default": 0 }, "enrichWithAI": { "title": "AI sponsorship label", "type": "boolean", "description": "If true, a third-party AI processor adds sponsorshipCategory (esports-tournament, pro-player, variety-streamer, just-chatting-irl, creator-small, other) to each record. Default false.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings, e.g. {\"useApifyProxy\": true}. Twitch's public API normally works without a proxy; enable one only if runs report being blocked.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }