{ "openapi": "3.0.1", "info": { "title": "Twitch Search Pro", "description": "The fastest and cheapest Twitch search scraper for finding channels by keyword, niche, game, brand term, or username fragment. Export clean Twitch channel results with followers, live status, viewers, stream titles, descriptions, avatars, and channel URLs.", "version": "1.0", "x-build-id": "h27roGdMeT7l5h8qr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sentry~twitch-search-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sentry-twitch-search-pro", "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/sentry~twitch-search-pro/runs": { "post": { "operationId": "runs-sync-sentry-twitch-search-pro", "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/sentry~twitch-search-pro/run-sync": { "post": { "operationId": "run-sync-sentry-twitch-search-pro", "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": { "mode": { "title": "Mode", "enum": [ "channel_search", "top_categories", "top_live_streams", "streams_by_game", "channel_profiles", "channel_clips" ], "type": "string", "description": "Choose which Twitch dataset you want to collect.", "default": "channel_search" }, "queries": { "title": "Search Queries", "type": "array", "description": "Used in Channel Search mode. Enter one or more keywords, game names, niches, brand terms, or username fragments.", "items": { "type": "string" } }, "gameSlugs": { "title": "Game / Category Slugs", "type": "array", "description": "Used in Streams by Game mode. Enter Twitch category slugs such as `league-of-legends`, `just-chatting`, or `valorant`.", "items": { "type": "string" } }, "channelLogins": { "title": "Channel Usernames", "type": "array", "description": "Used in Channel Profiles and Channel Clips modes. Enter Twitch usernames such as `shroud` or `pokimane`.", "items": { "type": "string" } }, "maxPages": { "title": "Max Pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum pages to fetch in Channel Search mode.", "default": 3 }, "maxResultsPerQuery": { "title": "Max Results Per Input", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum rows to return for each search query, game slug, or channel username where applicable.", "default": 50 }, "maxResultsTotal": { "title": "Max Results Total", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum rows to return for the entire run.", "default": 200 }, "requestTimeoutSec": { "title": "Request Timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Maximum time to wait for each Twitch request.", "default": 30 }, "includeRaw": { "title": "Include Raw Twitch Payload", "type": "boolean", "description": "Include the raw Twitch response object on each dataset row for debugging or custom downstream parsing.", "default": false } } }, "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 } } } } } } } } } }