{ "openapi": "3.0.1", "info": { "title": "Twitch & Kick Scraper – Live Streams, Channels, VODs, Clips", "description": "Twitch and Kick scraper in one normalized schema: channels with followers, live streams with viewer counts, VODs, clips and top categories. Public data only, no login or API keys. Track creators across both platforms.", "version": "1.0", "x-build-id": "CpSjuxaNDxOzhtaF9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/openharvest~twitch-kick-streaming-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-openharvest-twitch-kick-streaming-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/openharvest~twitch-kick-streaming-scraper/runs": { "post": { "operationId": "runs-sync-openharvest-twitch-kick-streaming-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/openharvest~twitch-kick-streaming-scraper/run-sync": { "post": { "operationId": "run-sync-openharvest-twitch-kick-streaming-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": { "channels": { "title": "Channels", "type": "array", "description": "Channel names or links. A plain name like \"xqc\" is looked up on every selected platform. Links (https://www.twitch.tv/xqc, https://kick.com/xqc) or prefixes (twitch:xqc, kick:xqc) target one platform.", "items": { "type": "string" } }, "platforms": { "title": "Platforms", "type": "array", "description": "Which platforms to use for plain channel names, live streams and categories.", "items": { "type": "string", "enum": [ "twitch", "kick" ], "enumTitles": [ "Twitch", "Kick" ] }, "default": [ "twitch", "kick" ] }, "includeVideos": { "title": "Include VODs (past broadcasts)", "type": "boolean", "description": "Also save each channel's latest videos/VODs with views, duration and category.", "default": false }, "maxVideosPerChannel": { "title": "Max VODs per channel", "minimum": 1, "maximum": 100, "type": "integer", "description": "Newest first, up to 100. Platforms keep past broadcasts only for a limited time.", "default": 10 }, "includeClips": { "title": "Include top clips", "type": "boolean", "description": "Also save each channel's most-viewed clips in the selected period.", "default": false }, "clipsPeriod": { "title": "Clips period", "enum": [ "day", "week", "month", "all" ], "type": "string", "description": "Time window for the most-viewed clips.", "default": "week" }, "maxClipsPerChannel": { "title": "Max clips per channel", "minimum": 1, "maximum": 100, "type": "integer", "description": "Most-viewed first. Twitch: up to 100. Kick: up to 20 (Kick's public limit).", "default": 10 }, "maxLiveStreams": { "title": "Top live streams per platform", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Save the currently live streams with the most viewers (0 = off). If you leave channels empty and everything else off, 10 live streams per platform are returned.", "default": 0 }, "liveCategory": { "title": "Live streams: category / game", "type": "string", "description": "Only live streams in this category, e.g. \"Just Chatting\", \"Fortnite\", \"grand-theft-auto-v\". Leave empty for all categories." }, "liveLanguage": { "title": "Live streams: language", "type": "string", "description": "Only live streams in this language, as a 2-letter code, e.g. \"en\", \"es\", \"tr\", \"pt\". Leave empty for all languages." }, "maxCategories": { "title": "Top categories per platform", "minimum": 0, "maximum": 500, "type": "integer", "description": "Save the top categories/games by current live viewers, with broadcaster counts on Twitch (0 = off).", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Not needed normally; the scraper switches to this proxy only if a platform blocks a request." } } }, "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 } } } } } } } } } }