{ "openapi": "3.0.1", "info": { "title": "Twitch Streamer & Channel Analytics", "description": "Extract Twitch streamer profiles, live streams, top games, clips, and VODs. 6 modes in one actor. No API key, no browser, no proxy needed. Pairs with our Kick.com Analytics for complete streaming intelligence.", "version": "1.0", "x-build-id": "SYqUr5cB2oqwaKIyP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zhorex~twitch-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zhorex-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/zhorex~twitch-scraper/runs": { "post": { "operationId": "runs-sync-zhorex-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/zhorex~twitch-scraper/run-sync": { "post": { "operationId": "run-sync-zhorex-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": "Scraping mode", "enum": [ "channel_details", "live_streams", "top_games", "search", "clips", "videos" ], "type": "string", "description": "Select what data to extract from Twitch.", "default": "channel_details" }, "channelLogins": { "title": "Channel logins or URLs", "type": "array", "description": "Twitch usernames or full URLs (e.g., 'shroud' or 'https://www.twitch.tv/shroud'). Used in channel_details, clips, and videos modes.", "items": { "type": "string" } }, "searchQuery": { "title": "Search query", "type": "string", "description": "Keyword to search for channels (used in search mode only)." }, "gameFilter": { "title": "Game/Category filter", "type": "string", "description": "Filter live streams by game name (e.g., 'Fortnite', 'Just Chatting'). Used in live_streams mode. If no live stream matches the game, the run returns no rows and charges nothing for results." }, "minViewers": { "title": "Minimum viewers", "minimum": 0, "type": "integer", "description": "Only return live streams with at least this many viewers. Used in live_streams mode.", "default": 0 }, "clipsPeriod": { "title": "Clips time period", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_MONTH", "ALL_TIME" ], "type": "string", "description": "Time range for fetching clips. Used in clips mode.", "default": "LAST_WEEK" }, "videoType": { "title": "Video type", "enum": [ "ARCHIVE", "HIGHLIGHT", "UPLOAD" ], "type": "string", "description": "Type of videos to fetch. ARCHIVE = past broadcasts, HIGHLIGHT = highlights, UPLOAD = uploads. Used in videos mode.", "default": "ARCHIVE" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many results to ask for (1-500). Twitch hands out at most 30 per page and currently refuses the second page of live streams and search results, so live_streams (with or without gameFilter) and search return at most 30; top_games returns at most one row per category among the top 30 live streams. In clips and videos each channel returns at most maxResults divided by the number of entries in channelLogins (rounded down, at least 1). Not used in channel_details (one row per channel found).", "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 } } } } } } } } } }