# Twitch Chat Scraper (`nifty.codes/twitch-chat-scraper`) Actor Extract Twitch chat messages including user IDs, subscriber status, bits, and reply details. Powered by Twitch Scraper. - **URL**: https://apify.com/nifty.codes/twitch-chat-scraper.md - **Developed by:** [Nifty](https://apify.com/nifty.codes) (community) - **Categories:** Social media - **Stats:** 1 total users, 0 monthly users, 80.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $2.00 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Twitch Chat Scraper This actor extracts Messages in a Chat from Twitch. It captures real-time message content, user metadata, and reply threading from any active Twitch channel. #### Data Fields | Field Name | Description | Example | | --- | --- | --- | | Message Body | The text content of the message | "Hello world!" | | User Display Name | The visible name of the user | "TwitchUser123" | | User Login | The unique username of the user | "twitchuser123" | | User ID | Unique numerical ID for the user | "123456789" | | User Type | The role of the user | "mod" | | User Color | Hex code for the user name color | "#FF0000" | | Is Subscriber | Boolean indicating subscription status | true | | All Badges | List of badges held by the user | "subscriber/12, moderator/1" | | Bits | Number of bits sent with the message | 100 | | Timestamp | Date and time of the message | "2023-10-27T10:00:00Z" | | Type | Internal message type | "chat" | | Message Type | Category of the message | "privmsg" | | Has Reply | Boolean indicating if this is a reply | true | | Reply Parent Display Name | Name of the user being replied to | "OriginalPoster" | | Reply Parent Message Body | Content of the parent message | "What time does it start?" | | Reply Parent Message ID | Unique ID of the parent message | "abc-123-def" | | Reply Parent User ID | User ID of the parent message author | "987654321" | | Reply Parent User Login | Login of the parent message author | "originalposter" | #### Input - `urls`: Array of Twitch channel URL strings. Example: `https://www.twitch.tv/channelname`. - `maxItems`: Maximum number of chat messages to collect per URL. Default is 100. #### Example Input ```json { "urls": ["https://www.twitch.tv/example"], "maxItems": 50 } ```` #### Example Output ```json [ { "messageBody": "Great stream today!", "userDisplayName": "ViewerOne", "userLogin": "viewerone", "userId": "445566", "userType": "", "userColor": "#00FF00", "isSubscriber": true, "allBadges": "subscriber/6", "bits": 0, "timestamp": "2023-10-27T10:05:00Z", "type": "chat", "messageType": "privmsg", "hasReply": false, "replyParentDisplayName": null, "replyParentMessageBody": null, "replyParentMessageId": null, "replyParentUserId": null, "replyParentUserLogin": null }, { "messageBody": "I agree!", "userDisplayName": "ViewerTwo", "userLogin": "viewertwo", "userId": "778899", "userType": "mod", "userColor": "#0000FF", "isSubscriber": false, "allBadges": "moderator/1", "bits": 0, "timestamp": "2023-10-27T10:05:10Z", "type": "chat", "messageType": "privmsg", "hasReply": true, "replyParentDisplayName": "ViewerOne", "replyParentMessageBody": "Great stream today!", "replyParentMessageId": "msg-id-123", "replyParentUserId": "445566", "replyParentUserLogin": "viewerone" } ] ``` #### Want more from Twitch? This actor only covers **Messages in a Chat**. The full **Twitch Scraper** browser extension also includes **Channels in a List, Channels in a Search, Videos in a List, Clips in a List, Channel Details** with unlimited personal use, real-time scraping with your logged-in sessions, CSV/Excel/JSON export, field customization, and scheduled monitoring. **[Get the Twitch Scraper extension](https://nifty.codes/e/twitch-scraper)** #### Disclaimer This tool extracts publicly available data. Users are responsible for compliance with applicable terms of service. # Actor input Schema ## `urls` (type: `array`): URLs to scrape. Must match: twitch.tv ## `maxItems` (type: `integer`): Maximum number of items to extract per URL ## Actor input object example ```json { "urls": [ "https://www.twitch.tv/theburntpeanut_247" ], "maxItems": 100 } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("nifty.codes/twitch-chat-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("nifty.codes/twitch-chat-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call nifty.codes/twitch-chat-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=nifty.codes/twitch-chat-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Twitch Chat Scraper", "description": "Extract Twitch chat messages including user IDs, subscriber status, bits, and reply details. Powered by Twitch Scraper.", "version": "3.2", "x-build-id": "vKxCO2Fw2f6pamcBc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nifty.codes~twitch-chat-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nifty.codes-twitch-chat-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/nifty.codes~twitch-chat-scraper/runs": { "post": { "operationId": "runs-sync-nifty.codes-twitch-chat-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/nifty.codes~twitch-chat-scraper/run-sync": { "post": { "operationId": "run-sync-nifty.codes-twitch-chat-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": [ "urls" ], "properties": { "urls": { "title": "URLs", "type": "array", "description": "URLs to scrape. Must match: twitch.tv", "items": { "type": "string" }, "default": [ "https://www.twitch.tv/theburntpeanut_247" ] }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Maximum number of items to extract per URL", "default": 100 } } }, "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 } } } } } } } } } } ```