{ "openapi": "3.0.1", "info": { "title": "Twitch Streamer & Channel Analytics", "description": "Trending games/categories, global top live streams, top channels within a category, and per-channel trending-rank lookup -- no account or API key needed.", "version": "0.0", "x-build-id": "ngcvGMT87v9tbVNkn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zucchini_gopher_m2v~twitch-analytics-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zucchini_gopher_m2v-twitch-analytics-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/zucchini_gopher_m2v~twitch-analytics-scraper/runs": { "post": { "operationId": "runs-sync-zucchini_gopher_m2v-twitch-analytics-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/zucchini_gopher_m2v~twitch-analytics-scraper/run-sync": { "post": { "operationId": "run-sync-zucchini_gopher_m2v-twitch-analytics-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": "Mode", "enum": [ "top-games", "top-streams", "game-streams", "channel-rank" ], "type": "string", "description": "\"top-games\" lists trending games/categories by viewer count. \"top-streams\" lists the platform-wide top live streams. \"game-streams\" lists the top live channels within a specific game/category. \"channel-rank\" checks whether specific channel(s) are currently trending, with their approximate rank platform-wide and within their category.", "default": "top-games" }, "limit": { "title": "Max items", "minimum": 1, "maximum": 100, "type": "integer", "description": "\"top-games\"/\"top-streams\"/\"game-streams\" mode -- how many results to return. Twitch enforces a hard per-page ceiling for HTTP-only clients (30 for streams, 100 for games) -- see README for why deeper pagination isn't available.", "default": 30 }, "gameName": { "title": "Game/category name", "type": "string", "description": "\"game-streams\" mode -- the exact game/category name as it appears on Twitch (e.g. \"Just Chatting\", \"League of Legends\")." }, "gameNames": { "title": "Game/category names", "type": "array", "description": "\"game-streams\" mode only -- multiple game/category names to fetch in one run.", "items": { "type": "string" } }, "login": { "title": "Channel login", "type": "string", "description": "\"channel-rank\" mode -- a single Twitch channel login to check." }, "logins": { "title": "Channel logins", "type": "array", "description": "\"channel-rank\" mode only -- multiple channel logins to check in one run.", "items": { "type": "string" } }, "maxConcurrency": { "title": "Max concurrent workers", "minimum": 1, "maximum": 16, "type": "integer", "description": "\"game-streams\"/\"channel-rank\" mode -- how many games/channels to process in parallel.", "default": 4 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy configuration. Residential is on by default.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }