{
  "openapi": "3.0.1",
  "info": {
    "title": "Twitch Scraper - Channels, Live Streams, VODs, Clips & Chat",
    "description": "Scrape Twitch channels, live streams, VODs, clips, top categories and VOD chat: followers, viewers, partner status, emails, socials, schedule, chapters, clip MP4 links. Search, category and language filters, monitor mode. From $0.90 per 1,000 channels, no start fee.",
    "version": "0.1",
    "x-build-id": "X7Ej7QbdYjPg9yBKS"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/topapi~twitch-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-topapi-twitch-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/topapi~twitch-scraper/runs": {
      "post": {
        "operationId": "runs-sync-topapi-twitch-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/topapi~twitch-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-topapi-twitch-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": {
          "channels": {
            "title": "📺 Channels",
            "type": "array",
            "description": "Channel logins or links, e.g. \"shroud\", \"https://www.twitch.tv/pokimane\". One channel row each: followers, live stream, last broadcast, bio, emails, socials, panels, team.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "🔗 Twitch links",
            "type": "array",
            "description": "Any twitch.tv link: a channel, /videos, /clips, a VOD (/videos/2911460606), a clip, a category (/directory/category/valorant, /clips, /videos), /directory (top categories), /directory/all (top streams) or /search?term=.",
            "items": {
              "type": "string"
            }
          },
          "searchQueries": {
            "title": "🔎 Search terms",
            "type": "array",
            "description": "Words to search Twitch for, e.g. \"valorant\", \"speedrun\". Search type below picks channels, categories or videos.",
            "items": {
              "type": "string"
            }
          },
          "searchType": {
            "title": "Search type",
            "enum": [
              "channels",
              "categories",
              "videos"
            ],
            "type": "string",
            "description": "What the search terms look for. Channel results are full channel rows.",
            "default": "channels"
          },
          "categories": {
            "title": "🎮 Categories / games",
            "type": "array",
            "description": "Category names or slugs, e.g. \"Just Chatting\", \"valorant\", \"Grand Theft Auto V\". What to read from each is set in Category output.",
            "items": {
              "type": "string"
            }
          },
          "categoryOutput": {
            "title": "Category output",
            "type": "array",
            "description": "Rows to read from each category: its live streams, the channels streaming it (full channel rows, for lead lists), its top clips, its videos, or the category's own stats row.",
            "items": {
              "type": "string",
              "enum": [
                "streams",
                "channels",
                "clips",
                "videos",
                "details"
              ],
              "enumTitles": [
                "Live streams",
                "Channels streaming it (full profiles)",
                "Top clips",
                "Videos (VODs)",
                "Category stats row"
              ]
            },
            "default": [
              "streams"
            ]
          },
          "topStreams": {
            "title": "🔥 Top live streams",
            "type": "boolean",
            "description": "The most-watched live streams on all of Twitch right now (languages and tags below apply)."
          },
          "topCategories": {
            "title": "🏆 Top categories",
            "type": "boolean",
            "description": "Twitch's most-watched categories right now (up to 100): viewers, live channels, followers, tags."
          },
          "chatVideoUrls": {
            "title": "💬 VOD chat replay",
            "type": "array",
            "description": "VOD links or ids whose chat replay to export, one row per message, e.g. https://www.twitch.tv/videos/2911460606. Message caps are under Extra data.",
            "items": {
              "type": "string"
            }
          },
          "languages": {
            "title": "Stream languages",
            "type": "array",
            "description": "Only streams (and category clips / videos) in these languages. Empty = all languages; Twitch's 30-stream pages are then widened language by language.",
            "items": {
              "type": "string",
              "enum": [
                "EN",
                "ES",
                "PT",
                "DE",
                "FR",
                "RU",
                "JA",
                "KO",
                "IT",
                "ZH",
                "TR",
                "PL",
                "AR",
                "ZH_HK",
                "TH",
                "SV",
                "NL",
                "CS",
                "UK",
                "HU",
                "DA",
                "FI",
                "NO",
                "EL",
                "RO",
                "VI",
                "ID",
                "MS",
                "HI",
                "TL",
                "BG",
                "SK",
                "CA",
                "ASL",
                "OTHER"
              ],
              "enumTitles": [
                "English",
                "Spanish",
                "Portuguese",
                "German",
                "French",
                "Russian",
                "Japanese",
                "Korean",
                "Italian",
                "Chinese",
                "Turkish",
                "Polish",
                "Arabic",
                "Chinese (Hong Kong)",
                "Thai",
                "Swedish",
                "Dutch",
                "Czech",
                "Ukrainian",
                "Hungarian",
                "Danish",
                "Finnish",
                "Norwegian",
                "Greek",
                "Romanian",
                "Vietnamese",
                "Indonesian",
                "Malay",
                "Hindi",
                "Tagalog",
                "Bulgarian",
                "Slovak",
                "Catalan",
                "American Sign Language",
                "Other"
              ]
            }
          },
          "tags": {
            "title": "Stream tags",
            "type": "array",
            "description": "Only live streams carrying these tags, e.g. \"DropsEnabled\", \"Speedrun\", \"English\" (up to 5).",
            "items": {
              "type": "string"
            }
          },
          "streamSort": {
            "title": "Live stream sort",
            "enum": [
              "VIEWER_COUNT",
              "VIEWER_COUNT_ASC",
              "RECENT",
              "RELEVANCE"
            ],
            "type": "string",
            "description": "Order of live streams; the other orders are used to go past Twitch's 30-stream page.",
            "default": "VIEWER_COUNT"
          },
          "clipPeriod": {
            "title": "Clip period",
            "enum": [
              "LAST_DAY",
              "LAST_WEEK",
              "LAST_MONTH",
              "ALL_TIME"
            ],
            "type": "string",
            "description": "Clips made in this window (channel and category clips).",
            "default": "LAST_WEEK"
          },
          "clipSort": {
            "title": "Clip sort",
            "enum": [
              "VIEWS_DESC",
              "TRENDING"
            ],
            "type": "string",
            "description": "Most viewed, or Twitch's trending order.",
            "default": "VIEWS_DESC"
          },
          "videoType": {
            "title": "Video type",
            "enum": [
              "ARCHIVE",
              "HIGHLIGHT",
              "UPLOAD",
              "PAST_PREMIERE"
            ],
            "type": "string",
            "description": "Past broadcasts, highlights, uploads or past premieres. Empty = all types."
          },
          "videoSort": {
            "title": "Video sort",
            "enum": [
              "TIME",
              "VIEWS"
            ],
            "type": "string",
            "description": "Newest first or most viewed first.",
            "default": "TIME"
          },
          "minFollowers": {
            "title": "Min followers",
            "minimum": 0,
            "type": "integer",
            "description": "Channels (and streamers of live streams) with at least this many followers, e.g. 1000."
          },
          "maxFollowers": {
            "title": "Max followers",
            "minimum": 0,
            "type": "integer",
            "description": "Channels (and streamers) with at most this many followers, e.g. 50000 for small creators."
          },
          "minViewers": {
            "title": "Min viewers",
            "minimum": 0,
            "type": "integer",
            "description": "Live streams with at least this many viewers now."
          },
          "maxViewers": {
            "title": "Max viewers",
            "minimum": 0,
            "type": "integer",
            "description": "Live streams with at most this many viewers now."
          },
          "minViews": {
            "title": "Min views",
            "minimum": 0,
            "type": "integer",
            "description": "Videos and clips with at least this many views."
          },
          "onlyLive": {
            "title": "Only live channels",
            "type": "boolean",
            "description": "Keep only channel rows that are live right now."
          },
          "onlyWithEmail": {
            "title": "Only channels with an email",
            "type": "boolean",
            "description": "Keep only channel rows with an email address in the bio or About panels."
          },
          "broadcasterType": {
            "title": "Broadcaster type",
            "enum": [
              "any",
              "partner",
              "affiliate",
              "partnerOrAffiliate",
              "none"
            ],
            "type": "string",
            "description": "Channels and streamers by Twitch status.",
            "default": "any"
          },
          "dateFrom": {
            "title": "From date",
            "type": "string",
            "description": "Videos and clips created (and streams started) on or after this day, e.g. 2026-10-01."
          },
          "dateTo": {
            "title": "To date",
            "type": "string",
            "description": "Videos and clips created (and streams started) on or before this day."
          },
          "maxAgeDays": {
            "title": "Max age (days)",
            "minimum": 1,
            "maximum": 3650,
            "type": "integer",
            "description": "Videos and clips from the last N days. Pairs well with a daily schedule."
          },
          "includeVideos": {
            "title": "➕ Channel videos (VODs)",
            "type": "boolean",
            "description": "Also save each channel's videos as video rows (title, views, duration, category, chapters) and list the latest 5 on the channel row."
          },
          "videosPerChannel": {
            "title": "Videos per channel",
            "minimum": 1,
            "maximum": 800,
            "type": "integer",
            "description": "Videos per channel. Twitch lists 100 per type and sort; more come from the other types and sorts.",
            "default": 20
          },
          "includeClips": {
            "title": "➕ Channel clips",
            "type": "boolean",
            "description": "Also save each channel's top clips as clip rows (views, curator, VOD moment) and list the top 5 on the channel row."
          },
          "clipsPerChannel": {
            "title": "Clips per channel",
            "minimum": 1,
            "maximum": 800,
            "type": "integer",
            "description": "Clips per channel within the clip period.",
            "default": 20
          },
          "includeClipDownloadUrls": {
            "title": "Clip MP4 links",
            "type": "boolean",
            "description": "Add an MP4 download link (best quality) to every clip row. Links expire after about a day."
          },
          "includeSchedule": {
            "title": "Channel schedule",
            "type": "boolean",
            "description": "Add each channel's upcoming scheduled streams and next stream time to the channel row (no extra charge)."
          },
          "includeEmotes": {
            "title": "Channel emotes",
            "type": "boolean",
            "description": "Add each channel's subscriber emotes (name, tier, image) to the channel row (no extra charge)."
          },
          "includeChapters": {
            "title": "VOD chapters",
            "type": "boolean",
            "description": "Add chapters (each category played and when) to video rows (no extra charge).",
            "default": true
          },
          "includeVodChat": {
            "title": "➕ Chat replay of saved VODs",
            "type": "boolean",
            "description": "Also export the chat replay of every past broadcast this run saves, one row per message."
          },
          "maxChatMessagesPerVideo": {
            "title": "Chat messages per VOD",
            "minimum": 0,
            "type": "integer",
            "description": "Messages per VOD, from the start (or From second). 0 = the whole replay.",
            "default": 1000
          },
          "chatStartSeconds": {
            "title": "Chat from second",
            "minimum": 0,
            "type": "integer",
            "description": "Start the chat replay this many seconds into the VOD, e.g. 3600 = 1 hour in."
          },
          "chatEndSeconds": {
            "title": "Chat to second",
            "minimum": 0,
            "type": "integer",
            "description": "Stop the chat replay at this second of the VOD. Empty = to the end."
          },
          "monitorMode": {
            "title": "🔁 Monitor mode",
            "type": "boolean",
            "description": "Save only rows not saved by earlier runs: new streams, videos, clips and chat; channels that are new, went live or offline, or changed followers."
          },
          "monitorOutput": {
            "title": "Monitor output",
            "enum": [
              "new",
              "changes",
              "all"
            ],
            "type": "string",
            "description": "What a monitor run saves.",
            "default": "changes"
          },
          "monitorStoreName": {
            "title": "Monitor memory name",
            "type": "string",
            "description": "Name of the key-value store that remembers earlier runs. Use one name per watch list.",
            "default": "twitch-monitor"
          },
          "maxItems": {
            "title": "Max rows",
            "minimum": 0,
            "type": "integer",
            "description": "Most rows to save in this run (channels, streams, videos, clips, categories). Chat messages are capped per VOD instead. 0 = no cap.",
            "default": 1000
          },
          "maxResultsPerSource": {
            "title": "Max rows per source",
            "minimum": 1,
            "type": "integer",
            "description": "Rows per category, search term, top list or channel /videos /clips link. Twitch shows ~25 live streams per view; more come from other sorts and languages.",
            "default": 30
          },
          "compact": {
            "title": "Compact rows",
            "type": "boolean",
            "description": "Core fields only, trimmed for spreadsheets and AI agents."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional. Twitch answers without a proxy; a proxy you set is tried first."
          },
          "maxConcurrency": {
            "title": "Parallel requests",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Requests to Twitch at the same time.",
            "default": 4
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}