# Twitch API guide



## Choose a Twitch operation



Start with the object your task needs. The groups below use the current catalogue; open an endpoint to check accepted identifiers, filters, price and availability before retrieving.



### Other operations



- [Twitch clip](https://www.monocrawl.com/docs/endpoints/twitch/clip) — Fetch a single Twitch clip from its URL: title, broadcaster, creator, game, duration, view count and thumbnail.

- [Twitch stream schedule](https://www.monocrawl.com/docs/endpoints/twitch/user/schedule) — A channel schedule snapshot with dated stream segments and any vacation window. Recurrence may be unavailable.



### Accounts and audiences



- [Channel profile](https://www.monocrawl.com/docs/endpoints/twitch/profile) — A Twitch channel: followers, partner status, live state and current viewers.



### Posts and media



- [Twitch user videos](https://www.monocrawl.com/docs/endpoints/twitch/user/videos) — A channel video snapshot with view counts and durations. The returned cursor continues within available source results; it does not promise an unlimited archive.



## Check fields and collection limits



Use the endpoint’s declared parameters and returned continuation. Filters from another platform do not automatically apply here. Preserve source identifiers, URLs and warnings; a successful page does not establish complete history. Published response schemas identify whether they come from a reviewed shaper or observed response shapes.



Agents can use `get_endpoint` for the current contract and `get_docs` with topic `platforms/twitch` to read this page. The [coverage guide](https://www.monocrawl.com/docs/data-availability) explains nulls and partial results, and the [production guide](https://www.monocrawl.com/docs/production-checklist) covers budgets and recovery.



## Endpoint reference

## twitch/clip

`GET /v1/twitch/clip`

Fetch a single Twitch clip from its URL: title, broadcaster, creator, game, duration, view count and thumbnail.

*Twitch clip*

| Parameter | Required | Description |
| --- | --- | --- |
| `url` | yes | Twitch clip URL (clips.twitch.tv/<slug>, twitch.tv/<channel>/clip/<slug>) or a bare clip slug — e.g. `https://clips.twitch.tv/CloudySavageMarjoramRuleFive--ErzsYbE7UWvgCMQ` |
| `dry_run` | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. — e.g. `1` |

### Useful optional inputs

- `dry_run`: Read a free estimate before fetching sources or scheduling paid work. Zero credits; cache status and availability are snapshots rather than guarantees.

**Cost:** 2 credits at list price per successful uncached response; variable-cost operations may quote or settle a different charge. Confirmed uncharged or refunded failures report zero. Pending reconciliation can report credits_used:null; retain request_id and the original idempotency key.

```bash
curl "https://www.monocrawl.com/v1/twitch/clip?url=https%3A%2F%2Fclips.twitch.tv%2FCloudySavageMarjoramRuleFive--ErzsYbE7UWvgCMQ" \
  -H "x-api-key: mn_your_key_here"
```

### Response data

Illustrative abbreviated data; documented core fields are optional and may be null. Additional source fields are allowed.

```json
{
  "broadcaster": {
    "id": "example",
    "name": "example"
  },
  "created_at": "2026-09-01T12:00:00Z",
  "creator": {
    "id": "example",
    "name": "example"
  },
  "duration_seconds": 0,
  "embed_url": "https://example.com/example",
  "game_id": "example",
  "id": "example",
  "is_featured": false,
  "language": "example",
  "thumbnail_url": "https://example.com/example",
  "title": "example",
  "url": "https://example.com/example",
  "view_count": 0
}
```

[Field reference](https://www.monocrawl.com/docs/endpoints/twitch/clip#response) · [JSON Schema for response.data](https://www.monocrawl.com/schemas/twitch/clip.json)


## twitch/profile

`GET /v1/twitch/profile`

A Twitch channel: followers, partner status, live state and current viewers.

*Channel profile*

| Parameter | Required | Description |
| --- | --- | --- |
| `handle` | yes | Twitch login name. — e.g. `ishowspeed` |
| `dry_run` | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. — e.g. `1` |

### Useful optional inputs

- `dry_run`: Read a free estimate before fetching sources or scheduling paid work. Zero credits; cache status and availability are snapshots rather than guarantees.

**Cost:** 2 credits at list price per successful uncached response; variable-cost operations may quote or settle a different charge. Confirmed uncharged or refunded failures report zero. Pending reconciliation can report credits_used:null; retain request_id and the original idempotency key.

```bash
curl "https://www.monocrawl.com/v1/twitch/profile?handle=ishowspeed" \
  -H "x-api-key: mn_your_key_here"
```

### Response data

Illustrative abbreviated data; documented core fields are optional and may be null. Additional source fields are allowed.

```json
{
  "banner_image": "https://example.com/example",
  "description": "example",
  "display_name": "example",
  "followers": 0,
  "handle": "example",
  "id": "example",
  "is_live": false,
  "is_partner": false,
  "platform": "example",
  "profile_image": "https://example.com/example",
  "url": "https://example.com/example"
}
```

[Field reference](https://www.monocrawl.com/docs/endpoints/twitch/profile#response) · [JSON Schema for response.data](https://www.monocrawl.com/schemas/twitch/profile.json)


## twitch/user/schedule

`GET /v1/twitch/user/schedule`

A channel schedule snapshot with dated stream segments and any vacation window. Recurrence may be unavailable.

*Twitch stream schedule*

| Parameter | Required | Description |
| --- | --- | --- |
| `handle` | yes | Twitch login name (the channel username) — e.g. `emongg` |
| `dry_run` | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. — e.g. `1` |

### Useful optional inputs

- `dry_run`: Read a free estimate before fetching sources or scheduling paid work. Zero credits; cache status and availability are snapshots rather than guarantees.

**Cost:** 2 credits at list price per successful uncached response; variable-cost operations may quote or settle a different charge. Confirmed uncharged or refunded failures report zero. Pending reconciliation can report credits_used:null; retain request_id and the original idempotency key.

```bash
curl "https://www.monocrawl.com/v1/twitch/user/schedule?handle=emongg" \
  -H "x-api-key: mn_your_key_here"
```

### Response data

Illustrative abbreviated data; documented core fields are optional and may be null. Additional source fields are allowed.

```json
{
  "_warnings": [],
  "broadcaster": {
    "handle": "example",
    "id": "example"
  },
  "count": 0,
  "segments": []
}
```

[Field reference](https://www.monocrawl.com/docs/endpoints/twitch/user/schedule#response) · [JSON Schema for response.data](https://www.monocrawl.com/schemas/twitch/user/schedule.json)


## twitch/user/videos

`GET /v1/twitch/user/videos`

A channel video snapshot with view counts and durations. The returned cursor continues within available source results; it does not promise an unlimited archive.

*Twitch user videos*

| Parameter | Required | Description |
| --- | --- | --- |
| `handle` | yes | Twitch login name (the channel username) — e.g. `ishowspeed` |
| `filter_by` | no | Video type: all (default), upload, archive, highlight Accepted values: all, upload, archive, highlight. Case, spaces, hyphens and underscores are interchangeable. — e.g. `archive` |
| `sort_by` | no | Sort order: time (default) or views Accepted values: time, views. Case, spaces, hyphens and underscores are interchangeable. — e.g. `time` |
| `limit` | no | Videos per page, 1-100 (default 25) — e.g. `25` |
| `cursor` | no | Opaque pagination cursor from a previous page |
| `dry_run` | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. — e.g. `1` |

### Useful optional inputs

- `limit`: Bound the returned rows to what your task needs. A smaller limit does not necessarily reduce source calls or price; inspect the quote.
- `cursor`: Continue the same source traversal with the complete returned cursor. Saved-result retrieval and a new source page can have different prices; quote the next call.
- `dry_run`: Read a free estimate before fetching sources or scheduling paid work. Zero credits; cache status and availability are snapshots rather than guarantees.

**Cost:** 2 credits at list price per successful uncached response; variable-cost operations may quote or settle a different charge. Confirmed uncharged or refunded failures report zero. Pending reconciliation can report credits_used:null; retain request_id and the original idempotency key.

```bash
curl "https://www.monocrawl.com/v1/twitch/user/videos?handle=ishowspeed" \
  -H "x-api-key: mn_your_key_here"
```

### Response data

Illustrative abbreviated data; documented core fields are optional and may be null. Additional source fields are allowed.

```json
{
  "_warnings": [],
  "count": 0,
  "cursor": null,
  "dropped": 0,
  "items": [
    {
      "duration": "example",
      "duration_seconds": 0,
      "id": "example",
      "muted_segments": [],
      "published_at": "2026-09-01T12:00:00Z",
      "stream_id": "example",
      "thumbnail_url": "https://example.com/example",
      "title": "example",
      "url": "https://example.com/example",
      "view_count": 0
    }
  ],
  "user": {
    "handle": "example",
    "id": "example",
    "name": "example"
  }
}
```

[Field reference](https://www.monocrawl.com/docs/endpoints/twitch/user/videos#response) · [JSON Schema for response.data](https://www.monocrawl.com/schemas/twitch/user/videos.json)

