---
title: "Twitch Profile API"
method: GET
path: "/v1/twitch/profile"
tags: ["Twitch"]
---

# Twitch Profile API

`GET /v1/twitch/profile`

## Request

- Base URL: `https://api.captapi.com`
- URL: `https://api.captapi.com/v1/twitch/profile`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Twitch channel — handle + displayName, socials[], topClips, schedule preview, stream only when live (1 credit).

Pass a Twitch channel URL or username and get a clean profile (no GraphQL junk). Identity is handle + displayName only — login/username/name are not shipped (they collide with handle or displayName depending on the channel). bio / avatar / banner have no description/profileImage/bannerImage twins. Also: isPartner/isAffiliate, isLive, stream{title, game, gameBoxArtUrl, viewers, startedAt, thumbnail} when live (omitted when offline — isLive:false already said it), lastBroadcast{} when Twitch exposes one, socials[{platform,url,title}] from channel panels / socialMedias, recentVideos[] (same lean row as /twitch/user-videos: broadcastType, gameId/gameSlug, no per-row broadcaster*), topClips[], and schedule[] (lean preview, max 10). Canonical full schedule: GET /v1/twitch/user-schedule. Empty bio is omitted, not nulled. Accepts cache / cacheMaxAge=1d|3d|7d|14d|30d. Flat 1 credit.

Docs: https://captapi.com/apis/twitch-profile

## Query parameters

- `url` string, required
- `cache` boolean
- `cacheMaxAge` '1d' | '3d' | '7d' | '14d' | '30d'

## Response `200`

Success. The data object for this endpoint.

- object
  - `success` unknown, required
  - `data` object, required
    - `platform` string: Platform identifier for this response (matches the endpoint's platform).
    - `id` string: Stable platform ID for the item.
    - `displayName` string: Channel display name (e.g. Ninja, KaiCenat). Distinct from handle on most channels.
    - `url` string: Canonical URL of the item.
    - `followers` integer: Follower count.
    - `isPartner` boolean: Whether the channel is a platform Partner/partner.
    - `isAffiliate` boolean: Whether the channel is an affiliate.
    - `isLive` boolean: Whether the channel is currently live.
    - `recentVideos` object[]
      - `platform` string: Platform identifier for this response (matches the endpoint's platform).
      - `id` string: Id of this recent videos item.
      - `url` string: Canonical URL of the item.
      - `embedUrl` string: Platform embed URL when a real embed id is known. Do not invent from a page/permalink id.
      - `title` string: Title of this recent videos item.
      - `createdAt` string: Creation date (ISO 8601).
      - `durationSeconds` integer: Length in seconds for this item (full media length, or a segment span when the endpoint documents a start/end).
      - `views` integer: View count when the platform exposes one.
      - `thumbnail` string: VOD/clip thumbnail URL with Twitch's {width}x{height} placeholders substituted to 320x180 so the URL loads. See thumbnailTemplate for the raw template.
      - `thumbnailTemplate` string: Unsubstituted Twitch thumbnail template (…/{width}x{height}.jpg) when the source used placeholders — pick your own size.
      - `animatedPreviewUrl` string: VOD storyboard / animated preview strip when Twitch exposes it.
      - `broadcastType` string: Broadcast type. Example: "ARCHIVE".
      - `game` string: Category / game name string (not a GraphQL Game object).
      - `gameId` string: Twitch game/category id.
      - `gameSlug` string: Twitch game/category slug.
      - `gameBoxArtUrl` string: Category box art URL (additive media field).
      - `language` string: Detected or requested language code.
    - `topClips` object[]
      - `platform` string: Platform identifier for this response (matches the endpoint's platform).
      - `id` string: Id of this top clips item.
      - `slug` string: URL slug of the item.
      - `url` string: Canonical URL of the item.
      - `embedUrl` string: Platform embed URL when a real embed id is known. Do not invent from a page/permalink id.
      - `title` string: Title of this top clips item.
      - `views` integer: View count when the platform exposes one.
      - `createdAt` string: Creation date (ISO 8601).
      - `thumbnail` string: VOD/clip thumbnail URL with Twitch's {width}x{height} placeholders substituted to 320x180 so the URL loads. See thumbnailTemplate for the raw template.
      - `game` string: Category / game name string (not a GraphQL Game object).
      - `gameBoxArtUrl` string: Category box art URL (additive media field).
    - `schedule` object[]
      - `id` string: Id of this schedule item.
      - `startAt` string: Start at. Example: "2026-08-16T18:00:00Z".
      - `endAt` string: End at. Example: "2026-08-17T02:00:00Z".
      - `isRecurring` boolean: Is recurring. Example: false.
      - `isCancelled` boolean: Is cancelled. Example: false.
      - `firstOccurrenceAt` string
    - `socials` object[]
      - `platform` string: Platform identifier for this response (matches the endpoint's platform).
      - `url` string: Canonical URL of the item.
    - `createdAt` string: Creation date (ISO 8601).
    - `bio` string: Channel about text when the channel published one; omitted when empty.
    - `avatar` string: Profile image URL.
    - `banner` string: Channel banner URL.
    - `lastBroadcast` object
      - `title` string: Title of this last broadcast item.
      - `game` string: Category / game name string (not a GraphQL Game object).
      - `gameBoxArtUrl` string: Category box art URL (additive media field).
      - `startedAt` string: When the stream, clip, or broadcast segment started (ISO 8601).
    - `handle` string: Twitch login / URL slug (e.g. ninja). The join key — not a third username twin.

## Other responses

- `400`: Bad request: wrong platform URL, unknown endpoint, or an invalid parameter value. Not billed.
- `401`: Missing, invalid or revoked API key. Not billed.
- `402`: Not enough credits for this request. Not billed.
- `404`: The resource does not exist or is not public. Not billed.
- `422`: A required parameter is missing or has the wrong type. Not billed.
- `429`: Rate limit reached. Wait for Retry-After seconds. Not billed.
- `502`: The platform could not be reached or returned nothing usable. Retryable, not billed. 503 and 504 use the same envelope.

---

[API](https://skmtc.dev/captapi/apis/captapi-api.md) · [All operations](https://skmtc.dev/captapi/apis/captapi-api/llms.txt) · [OpenAPI document](https://skmtc.dev/captapi/apis/captapi-api/revisions/c9b9ac5ff1bd?raw)