{ "openapi": "3.0.1", "info": { "title": "Twitch Channel Scraper: Followers, Live Status & VODs", "description": "Check if a Twitch channel is live and its viewers, game and stream title, plus follower count, recent VODs and about panel links, for a list of channels. Streamer stats to Google Sheets, API or n8n. Went-live monitoring with alerts to Discord or Slack webhooks.", "version": "1.0", "x-build-id": "ghAoUDPOGlWbjjFSh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~twitch-channel-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-twitch-channel-lookup", "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/accountable_eel~twitch-channel-lookup/runs": { "post": { "operationId": "runs-sync-accountable_eel-twitch-channel-lookup", "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/accountable_eel~twitch-channel-lookup/run-sync": { "post": { "operationId": "run-sync-accountable_eel-twitch-channel-lookup", "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": [ "channels" ], "properties": { "channels": { "title": "Twitch channels to look up or monitor", "type": "array", "description": "One channel per line. Enter a Twitch login username (e.g. shroud) or a channel URL (e.g. https://www.twitch.tv/pokimane). Accepted formats: [object Object], [object Object]. You're only charged for the ones we actually find — a miss costs nothing.", "items": { "type": "string" } }, "testRun": { "title": "Try it first — only process the first 5", "type": "boolean", "description": "Turn this on to test your input on a small sample before running the full list. Turn it off to process everything.", "default": false }, "onlyFound": { "title": "Hide rows with no result", "type": "boolean", "description": "Only keep rows where something was actually found. Misses are always free, whether or not you show them here.", "default": false }, "includeKeywords": { "title": "Only keep rows containing", "type": "array", "description": "Optional. Only keep results that mention at least one of these words (e.g. a job title, a city, a product name). Leave empty to keep everything.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Skip rows containing", "type": "array", "description": "Optional. Drop any result that mentions one of these words. Leave empty to skip nothing.", "items": { "type": "string" } }, "maxResults": { "title": "Stop after this many results", "minimum": 1, "type": "integer", "description": "Optional. Stop the run once this many results have been found — useful for a quick, cheap sample. Leave blank for no limit." }, "includeVideos": { "title": "Include recent VODs", "type": "boolean", "description": "When checked, fetches the 5 latest VODs for each channel (id, title, publishedAt, lengthSeconds, viewCount, url).", "default": true }, "includePanels": { "title": "Include panel links", "type": "boolean", "description": "When checked, extracts links from the channel's about panels (sponsors, donations, social media, merch).", "default": true }, "onlyChangesSinceLastRun": { "title": "Only return channels that changed since last run (monitoring)", "type": "boolean", "description": "On: only emits a row when a channel went live (was offline last run) or has a new VOD. Unchanged channels are withheld and not billed. Perfect for scheduled went-live alerts. Off: every found channel is returned every run.", "default": false }, "deltaName": { "title": "Watchlist name (optional)", "type": "string", "description": "Optional. Name this watchlist's monitoring memory so you can keep two schedules of this actor apart, or preserve memory across channel list changes. Leave empty to auto-derive.", "default": "" }, "notifyUrl": { "title": "Send alerts to (Discord or Slack webhook, Telegram bot, or any URL)", "type": "string", "description": "Optional. When monitoring is on, each went-live or new-VOD change triggers an alert posted here. Discord/Slack: paste webhook URL. Telegram: https://api.telegram.org/bot/sendMessage?chat_id=. Any other URL receives JSON. Stored encrypted, never logged." }, "notifyFormat": { "title": "Message format", "enum": [ "auto", "discord", "slack", "telegram", "json" ], "type": "string", "description": "Leave on 'Detect from the link': discord.com links get Discord format, hooks.slack.com gets Slack, api.telegram.org gets Telegram, any other destination receives JSON.", "default": "auto" }, "maxNotificationsPerRun": { "title": "Most alert messages per run", "type": "integer", "description": "Up to 100. Above this, one summary message says how many more channels changed. 0 sends only the summary message.", "default": 10 }, "columns": { "title": "Which columns do you want?", "type": "array", "description": "Choose which pieces of information to include in each result row. All are included by default.", "items": { "type": "string", "enum": [ "login", "displayName", "channelUrl", "description", "followers", "isPartner", "isAffiliate", "createdAt", "isLive", "viewersCount", "streamTitle", "gameName", "lastStreamAt", "lastStreamTitle", "recentVideos", "socialLinks", "panelLinks", "changeType", "isNew", "notifyErrors" ], "enumTitles": [ "Login", "Display name", "Channel URL", "Description", "Followers", "Partner", "Affiliate", "Created at", "Is live", "Current viewers", "Stream title", "Game / category", "Last stream at", "Last stream title", "Recent VODs", "Social links", "Panel links", "Change type", "Is new", "Notification errors" ] }, "default": [ "login", "displayName", "channelUrl", "description", "followers", "isPartner", "isAffiliate", "createdAt", "isLive", "viewersCount", "streamTitle", "gameName", "lastStreamAt", "lastStreamTitle", "recentVideos", "socialLinks", "panelLinks", "changeType", "isNew", "notifyErrors" ] }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel requests. Keep conservative — this target has no browser fallback, so getting blocked costs more than slow-and-steady.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy config. Residential recommended for anti-bot-sensitive targets.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }