> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Twitch profile

> Read a Twitch channel page as JSON with the twitch-profile parser. $1 per 1,000 calls. Send the page to scrape. Examples in cURL, TypeScript and Python.

Reads a Twitch channel page, like twitch.tv/twitch, and returns one profile as JSON.

## Make a request

Send the page's URL to [scrape](https://docs.stophy.dev/api-reference/endpoint/scrape.md) with a `json` format that names the parser. Get an API key in the [Quickstart](https://docs.stophy.dev/quickstart).

```bash cURL theme={null}
curl -X POST https://api.stophy.dev/v1/scrape \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.twitch.tv/twitch","formats":[{"type":"json","parser":"twitch-profile"}]}'
```

```typescript TypeScript theme={null}
const response = await fetch("https://api.stophy.dev/v1/scrape", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.STOPHY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    url: "https://www.twitch.tv/twitch",
    formats: [{ type: "json", parser: "twitch-profile" }],
  }),
});
console.log(await response.json());
```

```python Python theme={null}
import os

import requests

response = requests.post(
    "https://api.stophy.dev/v1/scrape",
    headers={"Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}"},
    json={
        "url": "https://www.twitch.tv/twitch",
        "formats": [{"type": "json", "parser": "twitch-profile"}],
    },
)
print(response.json())
```

## Read the response

The parser's data is in `data.json`. Its fields include `id`, `url`, `handle`, `name`, `bio`, `avatarUrl`, `isVerified`, `followers`, `following`, `posts`, `website`, `location` and `category`. This sample is cut to the first items.

```json theme={null}
{
  "success": true,
  "data": {
    "json": {
      "id": "12826",
      "url": "https://www.twitch.tv/twitch",
      "handle": "twitch",
      "name": "Twitch",
      "bio": "Twitch is where thousands of communities come together for whatever, every day. ",
      "avatarUrl": "https://static-cdn.jtvnw.net/jtv_user_pictures/e437c251-ced5-476f-b3c6-fd6686c51550-profile_image-300x300.png",
      "isVerified": true,
      "followers": 2498456,
      "following": null,
      "posts": null,
      "website": null,
      "location": null,
      "category": null,
      "bannerUrl": "https://static-cdn.jtvnw.net/jtv_user_pictures/06dce325-ae71-46f9-8392-a35918c8a61a-profile_banner-480.png",
      "createdAt": "2007-05-22T10:39:54.238271Z",
      "isLive": true,
      "stream": {
        "id": "319945735639",
        "title": "GTAVI Countdown",
        "game": {
          "id": "1867279146",
          "name": "Grand Theft Auto VI"
        },
        "viewers": 3914,
        "startedAt": "2026-11-18T01:45:05Z"
      },
      "videos": [
        {
          "id": "2931942986",
          "url": "https://www.twitch.tv/videos/2931942986",
          "title": "GTAVI Countdown",
          "game": {
            "id": "1867279146",
            "name": "Grand Theft Auto VI"
          },
          "durationSeconds": 1735,
          "views": 22,
          "publishedAt": "2026-11-18T01:45:09Z",
          "thumbnailUrl": null
        }
      ]
    }
  }
}
```

## Options

This parser takes no options.

## Price

\$1 per 1,000 calls. See [Pricing](https://docs.stophy.dev/account/pricing.md).

## Limits and errors

* The URL must be a Twitch channel page, like twitch.tv/twitch. Gives the channel's name, description, followers, whether it is live now (with the stream's title, game, viewers and start time) and its 10 newest past broadcasts. Any other URL fails with `invalidRequest`.
* The answer comes back in `data.json`. If the page cannot be read, the call fails with an error code from [Errors](https://docs.stophy.dev/api-reference/errors.md).

## Related

* [Pre-built parsers](https://docs.stophy.dev/scrape/prebuilt-parsers) lists every parser.
* [Scrape](https://docs.stophy.dev/scrape/overview) has the options every scrape takes.
* [Twitch clips](https://docs.stophy.dev/scrape/prebuilt-parsers/video/twitch-clips.md)
* [YouTube search](https://docs.stophy.dev/scrape/prebuilt-parsers/video/youtube-search.md)
* [YouTube video](https://docs.stophy.dev/scrape/prebuilt-parsers/video/youtube-video.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.