{ "openapi": "3.0.1", "info": { "title": "Twitch Search & Streams Scraper", "description": "Search Twitch channels, live streams, VODs and categories, no OAuth needed. Keyword search runs to Twitch's natural end (~1,000 channels per term, not 30) and category runs slice by language to beat Twitch's 30-row cap. Returns followers, viewers, uptime, category, tags, partner status.", "version": "0.1", "x-build-id": "2HpnIwMuUPOyQD3xF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cirkit~twitch-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cirkit-twitch-search-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/cirkit~twitch-search-scraper/runs": { "post": { "operationId": "runs-sync-cirkit-twitch-search-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/cirkit~twitch-search-scraper/run-sync": { "post": { "operationId": "run-sync-cirkit-twitch-search-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": "What to scrape", "enum": [ "search", "category", "channels" ], "type": "string", "description": "Search runs a keyword search across Twitch. Category pulls the live streams currently in one or more directory categories. Channels looks up a known list of channel names directly.", "default": "search" }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search, one per line. Used only in Search mode. Each term is paginated to Twitch's natural end, which is roughly 1,000 channels or 700 videos per term.", "items": { "type": "string" } }, "searchIndex": { "title": "Search for", "enum": [ "channels", "videos", "games" ], "type": "string", "description": "Which Twitch index to search. Channels and Videos paginate deeply. Categories returns a single page of about 29 matches, because that is all Twitch's category index will serve.", "default": "channels" }, "categories": { "title": "Categories", "type": "array", "description": "Directory categories to pull live streams from, used only in Category mode. Type them as they appear on Twitch, for example \"Just Chatting\" or \"VALORANT\". Slugs (\"just-chatting\") and directory URLs also work.", "items": { "type": "string" } }, "languages": { "title": "Broadcaster languages", "type": "array", "description": "Which broadcaster languages to pull, used only in Category mode. Twitch serves at most 30 streams per request, so this actor asks once per language to get past that cap - more languages means more streams. Leave empty to sweep the twelve languages that carry the most Twitch inventory.", "default": [], "items": { "type": "string" } }, "channels": { "title": "Channel names", "type": "array", "description": "Channel names or twitch.tv URLs to look up, used only in Channels mode. Returns the same row shape as the other modes, live or offline.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on rows written to the dataset across every term, category or channel in this run. You are billed per row, so this is also your cost ceiling. Must be 1 or more.", "default": 200 }, "sortBy": { "title": "Sort live streams by", "enum": [ "VIEWER_COUNT", "VIEWER_COUNT_ASC", "RELEVANCE" ], "type": "string", "description": "Ordering for Category mode. Highest viewers first is the Twitch default; lowest viewers first surfaces small channels, which is what influencer discovery usually wants.", "default": "VIEWER_COUNT" }, "onlyLive": { "title": "Only channels that are live now", "type": "boolean", "description": "Drop channels that are not broadcasting at the moment this runs. Filtering happens before billing, so you are never charged for rows this removes. Category mode is always live by definition.", "default": false }, "minViewers": { "title": "Minimum viewers", "minimum": 0, "type": "integer", "description": "Drop live channels below this concurrent viewer count. Applied before billing. Leave empty for no floor." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Twitch's public GraphQL endpoint answers datacenter proxies, so the default Apify proxy is enough - residential is not needed and would cost roughly ten times more.", "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 } } }, "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 } } } } } } } } } }