{ "openapi": "3.0.1", "info": { "title": "Twitch Chat Scraper", "description": "Collect public chat from Twitch VOD replays, live channels, or recent channel VODs. Get message text, timing, sender details, badges, subscriber status, emotes, and source context in an Apify dataset. No Twitch login or API token is needed.", "version": "0.0", "x-build-id": "th8R90UkqTA9M5fkr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~twitch-chat/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-twitch-chat", "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/maximedupre~twitch-chat/runs": { "post": { "operationId": "runs-sync-maximedupre-twitch-chat", "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/maximedupre~twitch-chat/run-sync": { "post": { "operationId": "run-sync-maximedupre-twitch-chat", "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": [ "target" ], "properties": { "target": { "title": "Target", "enum": [ "vod", "live", "channelHistory" ], "type": "string", "description": "Choose what to collect from Twitch.", "default": "vod" }, "vodUrls": { "title": "VOD URLs", "type": "array", "description": "Add one or more public Twitch VOD URLs. The same options apply to each VOD in this run. Twitch must make the chat replay available.", "items": { "type": "object", "properties": { "url": { "title": "URL", "type": "string", "description": "Enter a public Twitch VOD URL.", "pattern": "^https?://(www\\.)?twitch\\.tv/videos/[0-9]+(?:[/?#].*)?$" } }, "required": [ "url" ] }, "default": [ { "url": "https://www.twitch.tv/videos/2832981655" } ] }, "vodStartOffsetSeconds": { "title": "Start at (seconds)", "minimum": 0, "type": "integer", "description": "Start collecting each VOD this many seconds into the stream. Leave empty to start at the beginning.", "default": 0 }, "liveChannel": { "title": "Channel", "type": "string", "description": "Enter one public Twitch channel name or URL that is live now. The Actor does not monitor it after the run ends." }, "liveMaxMessages": { "title": "Max live messages", "minimum": 1, "type": "integer", "description": "Stop after this many live chat messages. Leave empty to collect all available messages during the run, until the source is exhausted." }, "channelIds": { "title": "Channel IDs or names", "type": "array", "description": "Add one or more public Twitch channel IDs or names. The Actor finds recent archived broadcasts for each channel and collects their available chat.", "items": { "type": "string" } }, "channelMaxVods": { "title": "Max VODs per channel", "minimum": 1, "type": "integer", "description": "Stop after this many recent archived broadcasts for each channel. Leave empty to use all recent broadcasts Twitch makes available until the source is exhausted." }, "maxMessagesPerVod": { "title": "Max messages per VOD", "minimum": 1, "type": "integer", "description": "For VOD chat replay and Channel VOD history, stop each VOD after this many messages. Leave empty to collect all available messages until the source is exhausted. This setting is ignored for Live channel chat.", "default": 25 } } }, "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 } } } } } } } } } }