{ "openapi": "3.0.1", "info": { "title": "Kick Data Scraper", "description": "Discover Kick channels and get clean channel snapshots from search, category browsing, livestream discovery, or direct slugs.", "version": "1.0", "x-build-id": "tcjeANQCA1qONsmyb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/aitooolsmax~kick-data-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-aitooolsmax-kick-data-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/aitooolsmax~kick-data-scraper/runs": { "post": { "operationId": "runs-sync-aitooolsmax-kick-data-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/aitooolsmax~kick-data-scraper/run-sync": { "post": { "operationId": "run-sync-aitooolsmax-kick-data-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 do you want to do?", "enum": [ "channels", "livestreams", "search", "category" ], "type": "string", "description": "Choose one workflow. Use Get specific channels when you already know Kick usernames. Use Find live channels for live streams sorted or filtered by tags/languages. Use Search by keyword for terms such as poker, gta, or casino. Use Browse categories for category slugs such as just-chatting or slots.", "default": "channels" }, "channelSlugs": { "title": "Known channel usernames", "type": "array", "description": "Required only for Get specific channels mode. Enter Kick usernames or channel URLs you already know, for example xqc, trainwreckstv, or https://kick.com/asmongold. Discovery fields such as search keywords, categories, and live tags are ignored in this mode.", "items": { "type": "string" } }, "searchKeywords": { "title": "Search Keywords", "type": "string", "description": "Required only for Search by keyword mode. Searches Kick for channels and livestream results matching this text, then returns channel snapshots for discovered channels. This does not combine with live tag filters." }, "categorySlugs": { "title": "Category slugs", "type": "array", "description": "Required only for Browse categories mode. Enter one or more Kick category slugs; each category is browsed separately. Examples: just-chatting, irl, minecraft, slots. If you have a category URL, use the final URL segment.", "items": { "type": "string" } }, "categorySort": { "title": "Category Sort", "enum": [ "recommended", "viewers_high_to_low", "viewers_low_to_high" ], "type": "string", "description": "Sort order for Browse categories mode. Ignored unless mode is Browse categories." }, "categoryLanguages": { "title": "Category Languages", "type": "array", "description": "Optional language filters for Browse categories mode. Use language codes such as en, bg, de. Ignored unless mode is Browse categories.", "items": { "type": "string" } }, "livestreamSort": { "title": "Livestream Sort", "enum": [ "recommended", "viewers_high_to_low", "viewers_low_to_high" ], "type": "string", "description": "Sort order for Find live channels mode. Use this when you want currently live channels, for example highest-viewer streams first." }, "livestreamLanguages": { "title": "Livestream Languages", "type": "array", "description": "Optional language filters for Find live channels mode. Use language codes such as en, bg, de. Ignored unless mode is Find live channels.", "items": { "type": "string" } }, "livestreamTags": { "title": "Livestream Tags", "type": "array", "description": "Optional tag filters for Find live channels mode. Use exact Kick stream tags with no spaces, such as gaming, casual, gta, or gambling. Do not enter search phrases such as CS GO here; use Search by keyword for phrases. Ignored unless mode is Find live channels.", "items": { "type": "string" } }, "maxItems": { "title": "Max channel snapshots", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum channel snapshots to return from Search by keyword, Browse categories, or Find live channels modes. Ignored when using known channel usernames. Hard cap: 1000." } } }, "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 } } } } } } } } } }