# Twitch Live Streams Scraper (`w3crawler/twitch-streams-scraper`) Actor

Collects verified live stream cards from the public Twitch directory, optionally filtered to one category, and saves channel, stream, viewer, tag, and thumbnail fields.

- **URL**: https://apify.com/w3crawler/twitch-streams-scraper.md
- **Developed by:** [w3crawler](https://apify.com/w3crawler) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.99 / 1,000 live streams

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

### Twitch Live Streams Scraper

Reads public Twitch live-stream cards from the overall directory or one game
category. It uses one bounded HTTPS request to an official Twitch page, follows
at most three official-host redirects, deduplicates channels, and records public
query provenance.

Requests are direct by default. When Twitch returns only its client shell, the
Actor performs one bounded browser render of the same public page. Enable `proxyConfiguration` only if Twitch
withholds public cards; ordinary Apify Proxy should be tried before any
country-specific or residential group. Diagnostics contain exactly `url`,
`error`, `errorCode`, and `scrapedAt`.

For deterministic local QA, set `fixtureFile` to an Actor-relative JSON file
whose `queries` object contains `top` or `game:<slug>` with an `html` string.
Fixture mode never makes a network request.

### Input example

```json
{
  "gameName": "Minecraft",
  "maxItems": 10,
  "timeoutMs": 30000,
  "maxResponseBytes": 4000000,
  "proxyConfiguration": { "useApifyProxy": false }
}
```

Omit `gameName` to read the public overall directory. Live card fields are
collected only when present; a blocked page or page without server-rendered
cards produces an explicit diagnostic dataset row and `OUTPUT` status. A
diagnostic is never presented as a stream result.

### Local verification

```bash
npm ci --ignore-scripts --no-audit --no-fund --prefer-offline
npm test
npm run lint
npm run schema
apify run --purge --input-file .actor/input.json
npm run validate
```

The Actor makes no request retries and never stores proxy credentials in output
records. It does not solve challenges, use authenticated sessions, or access
non-public data.

You can download the dataset in various formats such as JSON, HTML, CSV, or Excel.

# Changelog

This Actor's version history is a separate document: https://apify.com/w3crawler/twitch-streams-scraper/changelog.md

# Actor input Schema

## `gameName` (type: `string`):

Optional public Twitch category name, for example Fortnite. Omit for the overall live directory.

## `maxItems` (type: `integer`):

Maximum number of unique stream cards to save.

## `timeoutMs` (type: `integer`):

Per-request timeout for the direct public Twitch page request.

## `maxResponseBytes` (type: `integer`):

Maximum Twitch HTML response size to read.

## `proxyConfiguration` (type: `object`):

Optional proxy transport. Start direct and enable Apify Proxy only if public cards are withheld.

## `fixtureFile` (type: `string`):

Optional Actor-relative JSON fixture used instead of a network request; never a URL.

## Actor input object example

```json
{
  "maxItems": 50,
  "timeoutMs": 30000,
  "maxResponseBytes": 4000000,
  "proxyConfiguration": {
    "useApifyProxy": false
  }
}
```

# Actor output Schema

## `dataset` (type: `string`):

No description

## `keyValueStore` (type: `string`):

No description

## `runSummary` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("w3crawler/twitch-streams-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("w3crawler/twitch-streams-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call w3crawler/twitch-streams-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,w3crawler/twitch-streams-scraper"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/HW0gCJCcxdj9pKEfN/builds/vcr7Ra4Vz8Zm4zCAz/openapi.json