> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scraperize.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Profile
> Fetches a public Twitch channel by username and returns it as clean JSON: id, handle, display name, description, created date, avatar and banner images, accent colour, partner/affiliate/staff flags, follower count, linked social media, whether the channel is live now (with the current stream — title, viewers, game, preview, tags — when it is), the most recent broadcast, and the first page of the channel's videos (newest first — id, title, type, duration, views, game, thumbnail). Only publicly available data is returned.
**Cost: 1 credit** per successful request. Errors and cache hits (`cache_max_age`) are free.
Paste this into ChatGPT, Claude or your coding assistant to generate working code for this endpoint (use the copy button).
```text Prompt
I want to make an API call to /v1/twitch/profile. Here are the details:
Endpoint: GET https://api.scraperize.com/v1/twitch/profile
Description: Fetches a public Twitch channel by username and returns it as clean JSON: id, handle, display name, description, created date, avatar and banner images, accent colour, partner/affiliate/staff flags, follower count, linked social media, whether the channel is live now (with the current stream — title, viewers, game, preview, tags — when it is), the most recent broadcast, and the first page of the channel's videos (newest first — id, title, type, duration, views, game, thumbnail). Only publicly available data is returned.
Required Headers:
- x-api-key: Your API key
Parameters:
- handle (string) [required]: The Twitch username (channel handle), e.g. `ishowspeed`.
- cache_max_age (select): Optional. Return a cached result if one this age or newer exists — served for **0 credits** with `meta.cached=true` and `meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and refreshes the cache. Omit to always scrape fresh.
Example Response:
{
"data": {
"profile": {
"id": "220476955",
"handle": "ishowspeed",
"displayName": "IShowSpeed",
"url": "https://www.twitch.tv/ishowspeed",
"description": "YouTube:IShowSpeed Instagram:IShowSpeed: Snapchat:wishowspeed Twitter: ishowspeedsui I luv y’all🐐💕",
"createdAt": "2018-05-10T04:36:13.160074Z",
"profileImageUrl": "https://static-cdn.jtvnw.net/jtv_user_pictures/46a38d3a-a39c-4c43-ac12-c331b1c469c2-profile_image-300x300.png",
"bannerImageUrl": "https://static-cdn.jtvnw.net/jtv_user_pictures/983dc814-a78c-4e5a-9d22-e6e7595c76e1-profile_banner-480.png",
"primaryColorHex": "FF4747",
"isPartner": true,
"isAffiliate": false,
"isStaff": null,
"isGlobalMod": null,
"followerCount": 6223177,
"socialLinks": [],
"isLive": false,
"stream": null,
"lastBroadcast": {
"id": "320496447582",
"title": "RONALDO RETIRED??? + SPEED VS EKITIKE 🇫🇷⚽️",
"startedAt": "2026-10-03T20:17:20.814804Z",
"game": {
"id": "509658",
"name": "Just Chatting",
"slug": "just-chatting",
"boxArtUrl": "https://static-cdn.jtvnw.net/ttv-boxart/509658-144x192.jpg"
}
},
"videos": [
{
"id": "2891015835",
"url": "https://www.twitch.tv/videos/2891015835",
"title": "Highlight: RONALDO RETIRED??? + SPEED VS EKITIKE 🇫🇷⚽️",
"type": "HIGHLIGHT",
"durationSeconds": 4267,
"viewCount": 2064,
"publishedAt": "2026-10-03T19:16:15Z",
"game": {
"id": "509658",
"name": "Just Chatting",
"slug": "just-chatting",
"boxArtUrl": "https://static-cdn.jtvnw.net/ttv-boxart/509658-144x192.jpg"
},
"thumbnailUrl": "https://static-cdn.jtvnw.net/cf_vods/d2vi6trrdongqn/e3eb4c976dfe1c972c78_ishowspeed_52655563137_4873771784//thumb/thumb2891015835-320x180.jpg",
"animatedThumbnailUrl": "https://d2vi6trrdongqn.cloudfront.net/e3eb4c976dfe1c972c78_ishowspeed_52655563137_4873771784/storyboards/2891015835-strip-0.jpg"
}
]
},
"fetchedAt": "2026-10-05T14:46:45.256Z"
},
"meta": {
"requestId": "req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f",
"creditsCharged": 1,
"creditsRemaining": 4999,
"cached": false
}
}
Please help me write code in my preferred programming language to make this API call and handle the response appropriately. Include error handling and best practices.
```
## OpenAPI
````yaml /api-reference/openapi.json get /v1/twitch/profile
openapi: 3.0.3
info:
title: Scraperize API
version: 1.0.0
description: >-
Extract public data from social media platforms as clean JSON. Endpoints are
split by platform and by what they return, e.g. `GET /v1/twitter/tweet`.
## Authentication
Send your API key in the `x-api-key` header (or `Authorization: Bearer
`). Create keys in your dashboard.
## Credits
Each successful live scrape costs **1 credit**. Credits are prepaid and
never expire.
## Caching
Every endpoint accepts an optional `cache_max_age`
(`1d`|`3d`|`7d`|`14d`|`30d`). A cache hit within that window is returned for
**0 credits**.
## Responses
Success returns `{ "data": …, "meta": { "requestId", … } }`. Errors return
`{ "error": { "code", "message", "requestId" } }` with a matching HTTP
status. `meta` on a scrape carries `creditsCharged`, `creditsRemaining`,
`cached`, and (on a hit) `cachedAt`.
## Rate limits
Requests are limited per team per minute; over the limit returns `429` with
a `Retry-After` header.
servers:
- url: https://api.scraperize.com
description: Production
security:
- ApiKeyAuth: []
tags:
- name: Twitter
description: Twitter / X scraping endpoints
- name: Facebook
description: Facebook scraping endpoints
- name: Linkme
description: Linkme (link.me) scraping endpoints
- name: Amazon
description: Amazon (creator shop / storefront) scraping endpoints
- name: Linkbio
description: Linkbio (lnk.bio) scraping endpoints
- name: Pillar
description: Pillar (pillar.io) scraping endpoints
- name: Komi
description: Komi (komi.io) scraping endpoints
- name: Linktree
description: Linktree (linktr.ee) scraping endpoints
- name: Kick
description: Kick (kick.com) scraping endpoints
- name: Snapchat
description: Snapchat (snapchat.com) scraping endpoints
- name: Telegram
description: Telegram (t.me) scraping endpoints
- name: LinkedIn
description: LinkedIn scraping endpoints
- name: Twitch
description: Twitch scraping endpoints
- name: TikTok
description: TikTok (tiktok.com) scraping endpoints
paths:
/v1/twitch/profile:
get:
tags:
- Twitch
summary: Profile
description: >-
Fetches a public Twitch channel by username and returns it as clean
JSON: id, handle, display name, description, created date, avatar and
banner images, accent colour, partner/affiliate/staff flags, follower
count, linked social media, whether the channel is live now (with the
current stream — title, viewers, game, preview, tags — when it is), the
most recent broadcast, and the first page of the channel's videos
(newest first — id, title, type, duration, views, game, thumbnail). Only
publicly available data is returned.
parameters:
- name: handle
in: query
required: true
description: The Twitch username (channel handle), e.g. `ishowspeed`.
schema:
type: string
example: ishowspeed
- name: cache_max_age
in: query
required: false
description: >-
Optional. Return a cached result if one this age or newer exists —
served for **0 credits** with `meta.cached=true` and
`meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and
refreshes the cache. Omit to always scrape fresh.
schema:
type: string
enum:
- 1d
- 3d
- 7d
- 14d
- 30d
example: 7d
responses:
'200':
description: The channel profile.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
profile:
type: object
nullable: true
fetchedAt:
type: string
format: date-time
meta:
type: object
description: >-
requestId + credit/caching metadata (creditsCharged,
creditsRemaining, cached, cachedAt).
required:
- data
- meta
example:
data:
profile:
id: '220476955'
handle: ishowspeed
displayName: IShowSpeed
url: https://www.twitch.tv/ishowspeed
description: >-
YouTube:IShowSpeed Instagram:IShowSpeed:
Snapchat:wishowspeed Twitter: ishowspeedsui I luv
y’all🐐💕
createdAt: '2018-05-10T04:36:13.160074Z'
profileImageUrl: >-
https://static-cdn.jtvnw.net/jtv_user_pictures/46a38d3a-a39c-4c43-ac12-c331b1c469c2-profile_image-300x300.png
bannerImageUrl: >-
https://static-cdn.jtvnw.net/jtv_user_pictures/983dc814-a78c-4e5a-9d22-e6e7595c76e1-profile_banner-480.png
primaryColorHex: FF4747
isPartner: true
isAffiliate: false
isStaff: null
isGlobalMod: null
followerCount: 6223177
socialLinks: []
isLive: false
stream: null
lastBroadcast:
id: '320496447582'
title: RONALDO RETIRED??? + SPEED VS EKITIKE 🇫🇷⚽️
startedAt: '2026-10-03T20:17:20.814804Z'
game:
id: '509658'
name: Just Chatting
slug: just-chatting
boxArtUrl: >-
https://static-cdn.jtvnw.net/ttv-boxart/509658-144x192.jpg
videos:
- id: '2891015835'
url: https://www.twitch.tv/videos/2891015835
title: >-
Highlight: RONALDO RETIRED??? + SPEED VS EKITIKE
🇫🇷⚽️
type: HIGHLIGHT
durationSeconds: 4267
viewCount: 2064
publishedAt: '2026-10-03T19:16:15Z'
game:
id: '509658'
name: Just Chatting
slug: just-chatting
boxArtUrl: >-
https://static-cdn.jtvnw.net/ttv-boxart/509658-144x192.jpg
thumbnailUrl: >-
https://static-cdn.jtvnw.net/cf_vods/d2vi6trrdongqn/e3eb4c976dfe1c972c78_ishowspeed_52655563137_4873771784//thumb/thumb2891015835-320x180.jpg
animatedThumbnailUrl: >-
https://d2vi6trrdongqn.cloudfront.net/e3eb4c976dfe1c972c78_ishowspeed_52655563137_4873771784/storyboards/2891015835-strip-0.jpg
- id: '2890898173'
url: https://www.twitch.tv/videos/2890898173
title: RONALDO RETIRED??? + SPEED VS EKITIKE 🇫🇷⚽️
type: ARCHIVE
durationSeconds: 11122
viewCount: 556155
publishedAt: '2026-10-03T17:11:49Z'
game:
id: '509658'
name: Just Chatting
slug: just-chatting
boxArtUrl: >-
https://static-cdn.jtvnw.net/ttv-boxart/509658-144x192.jpg
thumbnailUrl: >-
https://static-cdn.jtvnw.net/cf_vods/d2vi6trrdongqn/a5e92c0842e6396d041e_ishowspeed_320496447582_1791047505//thumb/thumb0-320x180.jpg
animatedThumbnailUrl: >-
https://d2vi6trrdongqn.cloudfront.net/a5e92c0842e6396d041e_ishowspeed_320496447582_1791047505/storyboards/2890898173-strip-0.jpg
- id: '2876010826'
url: https://www.twitch.tv/videos/2876010826
title: PLAYING FC PARK
type: HIGHLIGHT
durationSeconds: 3082
viewCount: 8189
publishedAt: '2026-09-16T21:14:06Z'
game:
id: '509658'
name: Just Chatting
slug: just-chatting
boxArtUrl: >-
https://static-cdn.jtvnw.net/ttv-boxart/509658-144x192.jpg
thumbnailUrl: >-
https://static-cdn.jtvnw.net/cf_vods/d2vi6trrdongqn/ccc00b93d165b0485380_ishowspeed_33166857314_8934430343//thumb/thumb2876010826-320x180.jpg
animatedThumbnailUrl: >-
https://d2vi6trrdongqn.cloudfront.net/ccc00b93d165b0485380_ishowspeed_33166857314_8934430343/storyboards/2876010826-strip-0.jpg
fetchedAt: '2026-10-05T14:46:45.256Z'
meta:
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
creditsCharged: 1
creditsRemaining: 4999
cached: false
'401':
description: Missing, invalid, or revoked API key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: UNAUTHORIZED
message: API key required — pass it in the `x-api-key` header.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'402':
description: Not enough credits for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: INSUFFICIENT_CREDITS
message: >-
This request costs 1 credit, but your balance is 0. Top up
to continue.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'404':
description: No public Twitch channel found for that handle.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: NOT_FOUND
message: >-
The requested content was not found (it may not exist, be
deleted, or be private).
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'422':
description: Invalid query parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: VALIDATION_ERROR
message: Request validation failed
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
details:
- path: url
message: Required
'429':
description: Over the per-minute rate limit — honour `Retry-After`.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: RATE_LIMITED
message: >-
Rate limit exceeded — max 100 requests per 60s. Retry in
~30s.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'503':
description: >-
Temporarily unavailable — retry after `Retry-After`. `error.code`
tells you why: `UPSTREAM_BLOCKED` (the source blocked this request),
`EXTRACTION_FAILED` (the source returned unexpected data),
`PLATFORM_UNAVAILABLE` (the source is down), or
`SERVICE_UNAVAILABLE` (we are at capacity).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: UPSTREAM_BLOCKED
message: >-
The source is temporarily unavailable. Please try again
shortly.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
components:
schemas:
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: NOT_FOUND
message:
type: string
example: The requested content was not found.
requestId:
type: string
example: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
details:
type: array
items:
type: object
description: Present on validation errors.
required:
- code
- message
- requestId
required:
- error
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
Your API key. Send it in the `x-api-key` header (or `Authorization:
Bearer `). Create and manage keys from your dashboard.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.