{
  "openapi": "3.0.1",
  "info": {
    "title": "Twitch Scraper — Streamers, Influencer Emails & Socials",
    "description": "Find Twitch streamers and gaming influencers by category, keyword (live or offline), language, followers and average views, or look up any channel: business emails, Instagram, TikTok, YouTube and X links, engagement rate, streaming frequency and sponsors. Influencer leads, fast.",
    "version": "0.1",
    "x-build-id": "V4eVaH3g4aShyFbaT"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/cleandata~twitch-streamers-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-cleandata-twitch-streamers-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/cleandata~twitch-streamers-scraper/runs": {
      "post": {
        "operationId": "runs-sync-cleandata-twitch-streamers-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/cleandata~twitch-streamers-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-cleandata-twitch-streamers-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": {
          "categories": {
            "title": "Categories / games",
            "type": "array",
            "description": "Find streamers who are live in these categories, e.g. <code>Minecraft</code>, <code>Just Chatting</code>, <code>Fortnite</code>, or a category URL like <code>https://www.twitch.tv/directory/category/valorant</code>.",
            "items": {
              "type": "string"
            }
          },
          "searchKeywords": {
            "title": "Search keywords",
            "type": "array",
            "description": "Find channels with Twitch's own search, e.g. <code>ASMR</code>, <code>speedrun</code>, <code>cozy games</code>, <code>valorant coach</code>. Unlike categories, this also finds streamers who are offline right now (up to about 800 per keyword, live ones first). Languages filter these results.",
            "items": {
              "type": "string"
            }
          },
          "languages": {
            "title": "Stream languages",
            "type": "array",
            "description": "Only streams in these languages, as 2-letter codes: <code>EN</code>, <code>ES</code>, <code>PT</code>, <code>DE</code>, <code>FR</code>, <code>IT</code>, <code>JA</code>, <code>KO</code>, <code>PL</code>, <code>TR</code>… Each language also finds more streamers per category.",
            "items": {
              "type": "string"
            }
          },
          "channels": {
            "title": "Channels to look up",
            "type": "array",
            "description": "Usernames or channel URLs to get full profiles for, e.g. <code>xqc</code> or <code>https://www.twitch.tv/xqc</code>. They don't need to be live.",
            "items": {
              "type": "string"
            }
          },
          "minFollowers": {
            "title": "Min followers",
            "minimum": 0,
            "type": "integer",
            "description": "Skip channels with fewer followers (0 = no minimum). Great for finding micro-influencers together with Max followers.",
            "default": 0
          },
          "maxFollowers": {
            "title": "Max followers",
            "minimum": 0,
            "type": "integer",
            "description": "Skip channels with more followers (0 = no maximum).",
            "default": 0
          },
          "onlyWithEmail": {
            "title": "Only channels with a business email",
            "type": "boolean",
            "description": "Only return channels that publish an email address in their bio or panels.",
            "default": false
          },
          "emailTypes": {
            "title": "Email types",
            "type": "array",
            "description": "Keep only channels whose emails are of these types (leave empty for any): <b>company</b> = on their own or their agency's domain, like business@brand.com; <b>free provider</b> = Gmail, Outlook, Yahoo or similar; <b>both</b> = one of each. Channels without an email are skipped when this is set.",
            "items": {
              "type": "string",
              "enum": [
                "company",
                "free provider",
                "both"
              ],
              "enumTitles": [
                "Company domain",
                "Free provider (Gmail, Outlook…)",
                "Both"
              ]
            }
          },
          "minAvgViews": {
            "title": "Min average views per broadcast",
            "minimum": 0,
            "type": "integer",
            "description": "Skip channels whose recent broadcasts average fewer views (0 = no minimum). Followers can be old or inflated; average views show the audience a streamer really has today. Channels that keep no saved broadcasts (VODs) have no average and are skipped when this is set.",
            "default": 0
          },
          "activeWithinDays": {
            "title": "Streamed in the last X days",
            "minimum": 0,
            "type": "integer",
            "description": "Only channels that are live now or streamed within this many days (0 = any). Most useful with <b>Search keywords</b> or <b>Channels to look up</b>, which also return offline channels: streamers found through categories are live already.",
            "default": 0
          },
          "twitchStatus": {
            "title": "Twitch status",
            "enum": [
              "any",
              "affiliate",
              "partner"
            ],
            "type": "string",
            "description": "Keep only Twitch Partners, or Partners and Affiliates (streamers Twitch already pays, usually more established).",
            "default": "any"
          },
          "maxResults": {
            "title": "Max channels",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of channels for the whole run (0 = no limit).",
            "default": 100
          },
          "includeVideosAndClips": {
            "title": "Include recent VODs and top clips",
            "type": "boolean",
            "description": "Add the 5 latest VODs (title, link, views, length, game) and the 5 most viewed clips of the last 30 days (title, link, views, length, who clipped it) to each channel, so you can check their content without opening Twitch. Off by default: it adds columns to CSV and Excel exports. No extra cost.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Residential proxies are recommended: Twitch hides social links from datacenter IPs. Traffic is tiny (a few KB per channel), so proxy costs stay at cents per thousand channels.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ]
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}