{
  "openapi": "3.0.1",
  "info": {
    "title": "Kick Channel Scraper - Streamers, VODs, Clips & Live Streams",
    "description": "Scrape Kick.com streamers in bulk: followers, verified status, bio, socials and live status, plus past broadcasts, top clips and live channels.",
    "version": "1.0",
    "x-build-id": "t1bDTswkD8LNEIz6f"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/seemuapps~kick-channel-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-seemuapps-kick-channel-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/seemuapps~kick-channel-scraper/runs": {
      "post": {
        "operationId": "runs-sync-seemuapps-kick-channel-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/seemuapps~kick-channel-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-seemuapps-kick-channel-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": "What to scrape",
            "enum": [
              "channels",
              "videos",
              "clips",
              "live"
            ],
            "type": "string",
            "description": "Channel profiles: one row per channel with followers, verified badge, bio, social links and live status. Past broadcasts: every VOD Kick still hosts for each channel. Clips: a channel's clips sorted by views or date. Live streams: channels streaming right now, highest viewers first, optionally filtered by category and language.",
            "default": "channels"
          },
          "channels": {
            "title": "Channels",
            "type": "array",
            "description": "Kick channel names or URLs, one per line - e.g. xqc, @adinross or https://kick.com/trainwreckstv. Used by the Channel profiles, Past broadcasts and Clips modes.",
            "items": {
              "type": "string"
            }
          },
          "includeAboutLinks": {
            "title": "Include About-panel links and sub price",
            "type": "boolean",
            "description": "Channel profiles mode: also return the links from the channel's About panel (sponsor, merch, tip links) and the monthly subscription price. Same number of requests, slightly larger responses.",
            "default": false
          },
          "maxVideosPerChannel": {
            "title": "Max past broadcasts per channel",
            "minimum": 0,
            "type": "integer",
            "description": "Past broadcasts mode: newest broadcasts first. 0 = everything Kick still hosts (Kick keeps VODs for roughly the last 30 days).",
            "default": 0
          },
          "clipsSort": {
            "title": "Clip order",
            "enum": [
              "view",
              "date"
            ],
            "type": "string",
            "description": "Clips mode: return the most viewed clips first or the newest clips first.",
            "default": "view"
          },
          "clipsTimeRange": {
            "title": "Clip time range",
            "enum": [
              "day",
              "week",
              "month",
              "all"
            ],
            "type": "string",
            "description": "Clips mode: only include clips created within this window.",
            "default": "all"
          },
          "maxClipsPerChannel": {
            "title": "Max clips per channel",
            "minimum": 0,
            "type": "integer",
            "description": "Clips mode: stop after this many clips for each channel. 0 = all clips (large channels have tens of thousands).",
            "default": 100
          },
          "liveCategories": {
            "title": "Live: categories",
            "type": "array",
            "description": "Live streams mode: only return streams in these categories. Use the slug from the category page URL, e.g. just-chatting, slots, grand-theft-auto-v, counter-strike-2. Leave empty for all categories.",
            "items": {
              "type": "string"
            }
          },
          "liveParentCategory": {
            "title": "Live: top-level category",
            "enum": [
              "any",
              "games",
              "irl",
              "music",
              "gambling",
              "creative",
              "alternative"
            ],
            "type": "string",
            "description": "Live streams mode: restrict to one top-level section of Kick.",
            "default": "any"
          },
          "liveLanguages": {
            "title": "Live: languages",
            "type": "array",
            "description": "Live streams mode: only return streams in these languages. Accepts language names (English, Spanish) or codes (en, es, pt). Leave empty for all languages.",
            "items": {
              "type": "string"
            }
          },
          "minViewers": {
            "title": "Live: minimum viewers",
            "minimum": 0,
            "type": "integer",
            "description": "Live streams mode: skip streams with fewer concurrent viewers than this. The list is sorted by viewers, so the run stops as soon as it drops below the threshold.",
            "default": 0
          },
          "includeChannelDetails": {
            "title": "Live: add follower count and verified badge",
            "type": "boolean",
            "description": "Live streams mode: look up each live channel's follower count and verified status. Adds one request per stream, so runs take a little longer.",
            "default": false
          },
          "maxItems": {
            "title": "Max results",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of rows for the whole run, across all channels. 0 = no limit.",
            "default": 500
          },
          "pageId": {
            "title": "Page ID (pagination)",
            "type": "string",
            "description": "Paste NEXT_PAGE_ID from the previous run's Key-value store to continue where it stopped. Works for Live streams mode and for Clips mode with a single channel."
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional. By default the scraper connects directly and switches to datacenter and then residential proxies automatically only if Kick starts blocking. Set a proxy here to use it from the first request.",
            "default": {
              "useApifyProxy": 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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}