{ "openapi": "3.0.1", "info": { "title": "Kick.com Scraper: Streams, Clips & Channel Data", "description": "Extract channel profiles, live streams, VODs, and clips from Kick.com. Batch multiple channels per run. Filter by mature content and language. Real-time viewer counts, follower stats, and stream tags. No login needed, fast API-based extraction.", "version": "0.3", "x-build-id": "HgoqxAlhdixuelp9C" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~kick-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-kick-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/getascraper~kick-scraper/runs": { "post": { "operationId": "runs-sync-getascraper-kick-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/getascraper~kick-scraper/run-sync": { "post": { "operationId": "run-sync-getascraper-kick-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", "properties": { "mode": { "title": "Discovery mode", "enum": [ "watchlist", "search", "category" ], "type": "string", "description": "Choose a channel watchlist, text search, or category livestream scope.", "default": "watchlist" }, "watchlist": { "title": "Channel watchlist", "type": "array", "description": "Kick channel slugs or objects such as {\"channel\":\"xqc\",\"inputId\":\"xqc-main\"}.", "items": { "type": "string" } }, "channelNames": { "title": "Channel names (legacy alias)", "type": "array", "description": "Backward-compatible alias for watchlist.", "items": { "type": "string" } }, "query": { "title": "Search query", "type": "string", "description": "Search text used in search mode." }, "category": { "title": "Category slug", "type": "string", "description": "Kick category slug used in category mode, for example just-chatting." }, "recordTypes": { "title": "Record types", "type": "array", "description": "Channel, stream, clip, and/or vod. Watchlist defaults to channel and stream; category/search default to stream.", "items": { "type": "string" } }, "videoType": { "title": "Legacy video type", "enum": [ "videos", "clips" ], "type": "string", "description": "Legacy channel_videos alias: videos maps to vod, clips maps to clip.", "default": "videos" }, "maxResults": { "title": "Maximum records", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum source records emitted after filtering, sorting, and monitoring annotation.", "default": 100 }, "minFollowers": { "title": "Minimum followers", "minimum": 0, "type": "number", "description": "Keep channels with at least this source-published follower count." }, "minViewers": { "title": "Minimum live viewers", "minimum": 0, "type": "number", "description": "Keep live streams with at least this source-published viewer count." }, "language": { "title": "Language", "type": "string", "description": "Exact case-insensitive language code. languageFilter is accepted as a legacy alias." }, "tags": { "title": "Required tags", "type": "array", "description": "Keep records whose source-provided tags include these values.", "items": { "type": "string" } }, "verified": { "title": "Verified filter", "type": "boolean", "description": "Filter to source records marked as verified when set." }, "affiliate": { "title": "Affiliate filter", "type": "boolean", "description": "Filter to source records marked as affiliate when set." }, "mature": { "title": "Mature-content flag", "type": "boolean", "description": "Exact filter. Set false to exclude mature records; excludeMature is accepted as a legacy alias." }, "sortBy": { "title": "Sort field", "enum": [ "recordType", "followers", "viewers", "rank", "title", "category", "retrievedAt", "stableId" ], "type": "string", "description": "Deterministic source-field sort with stable ID tie-breaking.", "default": "recordType" }, "sortOrder": { "title": "Sort order", "enum": [ "asc", "desc" ], "type": "string", "description": "Ascending or descending order for the selected sort field.", "default": "asc" }, "monitorMode": { "title": "Monitor mode", "enum": [ "snapshot", "changes" ], "type": "string", "description": "Snapshot emits the current source view. Changes compares successful scans under stateKey.", "default": "snapshot" }, "stateKey": { "title": "State key", "pattern": "^[A-Za-z0-9_.:-]{1,120}$", "type": "string", "description": "Stable explicit key shared by scheduled changes runs.", "default": "kick-snapshot" }, "includeUnchanged": { "title": "Include unchanged records", "type": "boolean", "description": "In changes mode, also emit UNCHANGED records.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify Proxy configuration for source requests." } } }, "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 } } } } } } } } } }