{
  "openapi": "3.0.1",
  "info": {
    "title": "Kick Scraper - Channels, Live Streams, Clips & Creator Leads",
    "description": "Scrape Kick.com creators, live streams, clips, VODs & categories. Get followers, bios, social links (Instagram/Twitter/YouTube/TikTok/Discord), live viewer counts, lead scores & new-stream alerts.",
    "version": "0.1",
    "x-build-id": "pHRErKuWW2QSFpEl3"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~kick-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-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/scrapesage~kick-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-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/scrapesage~kick-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-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": {
          "inputType": {
            "title": "What to scrape",
            "enum": [
              "channels",
              "search",
              "liveStreams",
              "clips",
              "videos",
              "categories"
            ],
            "type": "string",
            "description": "Pick the mode. <b>Channels</b> = full creator profiles + leads from a list of usernames. <b>Search</b> = discover creators/games/streams by keyword. <b>Live streams</b> = top live streams right now (by viewers). <b>Clips</b> / <b>Videos</b> = a channel's clips / past broadcasts. <b>Categories</b> = top games/categories or specific ones. Start URLs work in any mode.",
            "default": "channels"
          },
          "channels": {
            "title": "Channel usernames",
            "type": "array",
            "description": "Kick usernames / channel slugs to scrape, e.g. <code>xqc</code>, <code>trainwreckstv</code>, <code>adin</code>. Full <code>kick.com/&lt;name&gt;</code> URLs also work. Used by the Channels, Clips and Videos modes.",
            "items": {
              "type": "string"
            }
          },
          "searchQueries": {
            "title": "Search keywords",
            "type": "array",
            "description": "Keywords to search Kick for (Search mode) — e.g. <code>valorant</code>, <code>poker</code>, <code>cooking</code>, a streamer name, or a game. Each keyword returns matching creators (and, with \"all\", categories & live streams).",
            "items": {
              "type": "string"
            }
          },
          "categorySlugs": {
            "title": "Category slugs",
            "type": "array",
            "description": "Specific Kick category/game slugs to scrape in Categories mode, e.g. <code>just-chatting</code>, <code>slots-and-casino</code>, <code>grand-theft-auto-v</code>. Leave empty to pull the current TOP categories.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "Kick URLs to scrape directly: a channel (<code>kick.com/&lt;name&gt;</code>), its clips (<code>kick.com/&lt;name&gt;/clips</code>) or videos (<code>kick.com/&lt;name&gt;/videos</code>), a category (<code>kick.com/category/&lt;slug&gt;</code>), or the browse/live page. Auto-routed by URL shape.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "language": {
            "title": "Live stream language",
            "type": "string",
            "description": "Language for the Live streams feed (e.g. <code>en</code>, <code>es</code>, <code>fr</code>, <code>de</code>, <code>tr</code>, <code>pt</code>). Kick localizes the featured live feed by language.",
            "default": "en"
          },
          "liveFeed": {
            "title": "Live feed type",
            "enum": [
              "featured",
              "latest"
            ],
            "type": "string",
            "description": "<b>Featured</b> = top live streams sorted by viewer count (best for finding the biggest streams). <b>Latest</b> = most recently started streams.",
            "default": "featured"
          },
          "searchEmit": {
            "title": "Search: also emit categories & live streams",
            "enum": [
              "channels",
              "all"
            ],
            "type": "string",
            "description": "In Search mode, output only matching creators, or also the matching categories and live streams a keyword returns.",
            "default": "channels"
          },
          "emitChannelLeads": {
            "title": "Also emit creator leads",
            "type": "boolean",
            "description": "For each channel (Channels & Search modes), also push a separate creator <b>lead</b> record with contactable social links (Instagram/Twitter/YouTube/TikTok/Discord) and a 0-100 lead score — ideal for influencer/sponsorship outreach.",
            "default": true
          },
          "includeClips": {
            "title": "Include each channel's clips",
            "type": "boolean",
            "description": "In Channels mode, also pull each channel's top clips (adds requests per channel). Pushed as separate clip records.",
            "default": false
          },
          "includeVideos": {
            "title": "Include each channel's videos (VODs)",
            "type": "boolean",
            "description": "In Channels mode, also pull each channel's recent past broadcasts / VODs. Pushed as separate video records.",
            "default": false
          },
          "clipSort": {
            "title": "Clip sort",
            "enum": [
              "view",
              "date"
            ],
            "type": "string",
            "description": "How to order clips (Clips mode / includeClips).",
            "default": "view"
          },
          "clipTime": {
            "title": "Clip time window",
            "enum": [
              "all",
              "day",
              "week",
              "month"
            ],
            "type": "string",
            "description": "Only clips created within this window.",
            "default": "all"
          },
          "maxClipsPerChannel": {
            "title": "Max clips per channel",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Maximum clips to pull per channel.",
            "default": 20
          },
          "maxVideosPerChannel": {
            "title": "Max videos per channel",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Maximum past broadcasts / VODs to pull per channel.",
            "default": 20
          },
          "minFollowers": {
            "title": "Min followers",
            "minimum": 0,
            "type": "integer",
            "description": "Only keep channels / streamers with at least this many followers (filters out tiny channels). 0 = no filter.",
            "default": 0
          },
          "verifiedOnly": {
            "title": "Verified only",
            "type": "boolean",
            "description": "Only keep verified channels / streamers.",
            "default": false
          },
          "affiliateOnly": {
            "title": "Affiliate (monetized) only",
            "type": "boolean",
            "description": "Only keep channels that are Kick affiliates (monetized) — usually the more established, contactable creators.",
            "default": false
          },
          "liveOnly": {
            "title": "Currently live only",
            "type": "boolean",
            "description": "In Channels / Search modes, only keep channels that are live right now.",
            "default": false
          },
          "minViewers": {
            "title": "Min live viewers",
            "minimum": 0,
            "type": "integer",
            "description": "In Live streams mode, only keep streams with at least this many concurrent viewers. 0 = no filter.",
            "default": 0
          },
          "excludeMature": {
            "title": "Exclude mature streams",
            "type": "boolean",
            "description": "In Live streams mode, drop streams flagged as mature / 18+.",
            "default": false
          },
          "maxResults": {
            "title": "Max results",
            "minimum": 1,
            "type": "integer",
            "description": "Maximum number of records to emit across the whole run (channels + leads + streams + clips + videos + categories all count).",
            "default": 100
          },
          "maxPages": {
            "title": "Max pages (live feed / clips)",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many pages to page through for the live feed and clip pagination.",
            "default": 10
          },
          "deduplicate": {
            "title": "Deduplicate",
            "type": "boolean",
            "description": "Drop duplicate channels/streams/clips that appear more than once in the same run.",
            "default": true
          },
          "monitorMode": {
            "title": "Monitor mode (only new items)",
            "type": "boolean",
            "description": "Remember items across runs in a named key-value store and emit ONLY records that are NEW since the last run — new channels, new live broadcasts (each go-live has a new stream id), new clips or new VODs. Pair with Apify <b>Schedules</b> for go-live & new-clip alerts: it complements the scheduler (the schedule starts the run; monitor mode dedupes against prior runs).",
            "default": false
          },
          "monitorKey": {
            "title": "Monitor key",
            "type": "string",
            "description": "Names the monitor's memory store so you can run several independent monitors (e.g. one per streamer or per category). Reuse the same key to keep tracking the same feed.",
            "default": "default"
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Parallel requests. Kick serves cleanly to Apify datacenter proxies; 3-6 is a good range.",
            "default": 5
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxies to use. Kick serves cleanly to Apify datacenter proxies; keep the default. A fresh proxy IP is used per request to spread rate limits. Switch to RESIDENTIAL only if you see repeated blocked/challenge warnings.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}