> ## 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.

# Channel search

> Searches within one YouTube channel by keyword, as the channel page's search does, about 30 results per page grouped by type: `videos` (past streams included), `shorts`, `lives` (streams live now, with viewers watching), `playlists`, `podcasts` and `shows`, with a count per group. Every result keeps its `position` on the page (YouTube's relevance order). Each video has its id, URL, title, description snippet, exact view count, when it was published, duration, badges, thumbnails and an animated preview; each playlist its id, kind, title, video count, last update and first videos. The response also carries a summary of the channel. Pass the returned `cursor` back (with the same handle and query) for the next page. Only publicly available data is returned.

> [!NOTE]
>
> **Cost: 1 credit** per successful request. Errors and cache hits (`cache_max_age`) are free.

> [accordion] Copy for AI assistant
>
> 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/youtube/channel/search. Here are the details:
>
> Endpoint: GET https://api.scraperize.com/v1/youtube/channel/search
> Description: Searches within one YouTube channel by keyword, as the channel page's search does, about 30 results per page grouped by type: `videos` (past streams included), `shorts`, `lives` (streams live now, with viewers watching), `playlists`, `podcasts` and `shows`, with a count per group. Every result keeps its `position` on the page (YouTube's relevance order). Each video has its id, URL, title, description snippet, exact view count, when it was published, duration, badges, thumbnails and an animated preview; each playlist its id, kind, title, video count, last update and first videos. The response also carries a summary of the channel. Pass the returned `cursor` back (with the same handle and query) for the next page. Only publicly available data is returned.
>
> Required Headers:
> - x-api-key: Your API key
>
> Parameters:
> - handle (string) [required]: The channel handle, with or without `@`, e.g. `MrBeast`.
> - query (string) [required]: The keyword(s) to search the channel for (up to 200 characters).
> - cursor (string): The `cursor` from the previous page, to get the next one. Omit for the first page.
> - 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": {
>     "channel": {
>       "id": "UCX6OQ3DkcsbYNE6H8uQQuVA",
>       "handle": "MrBeast",
>       "name": "MrBeast",
>       "url": "https://www.youtube.com/@MrBeast",
>       "avatarUrl": "https://yt3.googleusercontent.com/nxYrc_1_2f77DoBadyxMTmv7ZpRZapHR5jbuYe7PlPd5cIRJxtNNEYyOC0ZsxaDyJJzXrnJiuDE=s900-c-k-c0x00ffffff-no-rj",
>       "isVerified": true,
>       "subscriberCount": 525000000
>     },
>     "query": "squid game",
>     "results": {
>       "videos": [
>         {
>           "type": "video",
>           "id": "0e3GPea1Tyg",
>           "url": "https://www.youtube.com/watch?v=0e3GPea1Tyg",
>           "title": "$456,000 Squid Game In Real Life!",
>           "descriptionSnippet": "MAKE SURE YOU WATCH UNTIL GLASS BRIDGE IT'S INSANE!\n\nWatch Beast Games now on Prime Video!!! https://www.beastgames.com\n\nThank you GoPro for supplying us with c…",
>           "viewCount": 980843626,
>           "viewCountText": "980,843,626 views",
>           "concurrentViewers": null,
>           "publishedText": "4 years ago",
>           "wasLive": false,
>           "durationSeconds": 1542,
>           "durationText": "25:42",
>           "badges": [
>             "CC"
>           ],
>           "channelId": "UCX6OQ3DkcsbYNE6H8uQQuVA",
>           "channelName": "MrBeast",
>           "channelHandle": "MrBeast",
>           "isChannelVerified": true,
>           "thumbnailUrl": "https://i.ytimg.com/vi/0e3GPea1Tyg/hqdefault.jpg?sqp=-oaymwEgCNACELwBSFXyq4qpAxIIARUAAIhCGAFwAcABBrgC8xg=&rs=AOn4CLB1O9sjwkfsmjOvuR2hP0qvN9ZXFg",
>           "thumbnails": [
>             {
>               "url": "https://i.ytimg.com/vi/0e3GPea1Tyg/hqdefault.jpg?sqp=-oaymwEgCNACELwBSFXyq4qpAxIIARUAAIhCGAFwAcABBrgC8xg=&rs=AOn4CLB1O9sjwkfsmjOvuR2hP0qvN9ZXFg",
>               "width": 336,
>               "height": 188
>             }
>           ],
>           "previewUrl": "https://i.ytimg.com/an_webp/0e3GPea1Tyg/mqdefault_6s.webp?du=3000&sqp=CPjCqNcG&rs=AOn4CLCdwhJcZFzmDP2amvcz6D1zSlcWgg",
>           "position": 1
>         }
>       ],
>       "shorts": [
>         {
>           "type": "short",
>           "id": "DBw0oD38z0Q",
>           "url": "https://www.youtube.com/shorts/DBw0oD38z0Q",
>           "title": "This Game Is Wild",
>           "descriptionSnippet": null,
>           "viewCount": 243248747,
>           "viewCountText": "243,248,747 views",
>           "concurrentViewers": null,
>           "publishedText": "2 years ago",
>           "wasLive": false,
>           "durationSeconds": 21,
>           "durationText": "0:21",
>           "badges": [],
>           "channelId": "UCX6OQ3DkcsbYNE6H8uQQuVA",
>           "channelName": "MrBeast",
>           "channelHandle": "MrBeast",
>           "isChannelVerified": true,
>           "thumbnailUrl": "https://i.ytimg.com/vi/DBw0oD38z0Q/hqdefault.jpg?sqp=-oaymwE6CNACELwBSFXyq4qpAywIARUAAIhCGABwAcABBvABAfgBtgiAAoAPigIMCAAQARhlIFQoTzAPuALzGA==&rs=AOn4CLC7nAEMjEu…",
>           "thumbnails": [
>             {
>               "url": "https://i.ytimg.com/vi/DBw0oD38z0Q/hqdefault.jpg?sqp=-oaymwE6CNACELwBSFXyq4qpAywIARUAAIhCGABwAcABBvABAfgBtgiAAoAPigIMCAAQARhlIFQoTzAPuALzGA==&rs=AOn4CLC7nAEMjEu…",
>               "width": 336,
>               "height": 188
>             }
>           ],
>           "previewUrl": "https://i.ytimg.com/an_webp/DBw0oD38z0Q/mqdefault_6s.webp?du=3000&sqp=CLSsqNcG&rs=AOn4CLBIBCQ-V-qXIIrrmIrK16qrws9P3g",
>           "position": 2
>         }
>       ],
>       "lives": [],
>       "playlists": [],
>       "podcasts": [],
>       "shows": []
>     },
>     "counts": {
>       "videos": 9,
>       "shorts": 20,
>       "lives": 0,
>       "playlists": 0,
>       "podcasts": 0,
>       "shows": 0
>     },
>     "count": 29,
>     "cursor": "eyJoIjoibXJiZWFzdCIsInEiOiJzcXVpZCBnYW1lIiwiYyI6IjRxbUZzZ0o2RWhoVlExZzJUMUV6Ukd0amMySlpUa1UyU0RoMVVWRjFWa0VhSmtOQ01GTkNiazVzV1ZoS2FtRkVRVUpQUVVablFWZHZRV1ZuVGto…",
>     "hasMore": true,
>     "fetchedAt": "2026-11-03T18:46:48.112Z"
>   },
>   "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/youtube/channel/search
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
    <key>`). 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
  - name: Instagram
    description: Instagram scraping endpoints
  - name: Lagos Life
    description: Lagos Life scraping endpoints
  - name: Bluesky
    description: Bluesky (bsky.app) scraping endpoints
  - name: Threads
    description: Threads (threads.com) scraping endpoints
  - name: Truth Social
    description: Truth Social (truthsocial.com) scraping endpoints
  - name: YouTube
    description: YouTube (youtube.com) scraping endpoints
paths:
  /v1/youtube/channel/search:
    get:
      tags:
        - YouTube
      summary: Channel search
      description: >-
        Searches within one YouTube channel by keyword, as the channel page's
        search does, about 30 results per page grouped by type: `videos` (past
        streams included), `shorts`, `lives` (streams live now, with viewers
        watching), `playlists`, `podcasts` and `shows`, with a count per group.
        Every result keeps its `position` on the page (YouTube's relevance
        order). Each video has its id, URL, title, description snippet, exact
        view count, when it was published, duration, badges, thumbnails and an
        animated preview; each playlist its id, kind, title, video count, last
        update and first videos. The response also carries a summary of the
        channel. Pass the returned `cursor` back (with the same handle and
        query) for the next page. Only publicly available data is returned.
      parameters:
        - name: handle
          in: query
          required: true
          description: The channel handle, with or without `@`, e.g. `MrBeast`.
          schema:
            type: string
          example: MrBeast
        - name: query
          in: query
          required: true
          description: The keyword(s) to search the channel for (up to 200 characters).
          schema:
            type: string
          example: squid game
        - name: cursor
          in: query
          required: false
          description: >-
            The `cursor` from the previous page, to get the next one. Omit for
            the first page.
          schema:
            type: string
        - 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: One page of results (empty when nothing matches).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      channel:
                        type: object
                      query:
                        type: string
                      results:
                        type: object
                        description: The page grouped by type; each group in page order.
                        properties:
                          videos:
                            type: array
                            items:
                              type: object
                          shorts:
                            type: array
                            items:
                              type: object
                          lives:
                            type: array
                            items:
                              type: object
                          playlists:
                            type: array
                            items:
                              type: object
                          podcasts:
                            type: array
                            items:
                              type: object
                          shows:
                            type: array
                            items:
                              type: object
                      counts:
                        type: object
                        description: Results per group on this page.
                        properties:
                          videos:
                            type: integer
                          shorts:
                            type: integer
                          lives:
                            type: integer
                          playlists:
                            type: integer
                          podcasts:
                            type: integer
                          shows:
                            type: integer
                      count:
                        type: integer
                        description: All results on this page.
                      cursor:
                        type: string
                        nullable: true
                      hasMore:
                        type: boolean
                      fetchedAt:
                        type: string
                        format: date-time
                  meta:
                    type: object
                    description: >-
                      requestId + credit/caching metadata (creditsCharged,
                      creditsRemaining, cached, cachedAt).
                required:
                  - data
                  - meta
              example:
                data:
                  channel:
                    id: UCX6OQ3DkcsbYNE6H8uQQuVA
                    handle: MrBeast
                    name: MrBeast
                    url: https://www.youtube.com/@MrBeast
                    avatarUrl: >-
                      https://yt3.googleusercontent.com/nxYrc_1_2f77DoBadyxMTmv7ZpRZapHR5jbuYe7PlPd5cIRJxtNNEYyOC0ZsxaDyJJzXrnJiuDE=s900-c-k-c0x00ffffff-no-rj
                    isVerified: true
                    subscriberCount: 525000000
                  query: squid game
                  results:
                    videos:
                      - type: video
                        id: 0e3GPea1Tyg
                        url: https://www.youtube.com/watch?v=0e3GPea1Tyg
                        title: $456,000 Squid Game In Real Life!
                        descriptionSnippet: >-
                          MAKE SURE YOU WATCH UNTIL GLASS BRIDGE IT'S INSANE!


                          Watch Beast Games now on Prime Video!!!
                          https://www.beastgames.com


                          Thank you GoPro for supplying us with cameras to get
                          some of these shots....
                        viewCount: 980843626
                        viewCountText: 980,843,626 views
                        concurrentViewers: null
                        publishedText: 4 years ago
                        wasLive: false
                        durationSeconds: 1542
                        durationText: '25:42'
                        badges:
                          - CC
                        channelId: UCX6OQ3DkcsbYNE6H8uQQuVA
                        channelName: MrBeast
                        channelHandle: MrBeast
                        isChannelVerified: true
                        thumbnailUrl: >-
                          https://i.ytimg.com/vi/0e3GPea1Tyg/hqdefault.jpg?sqp=-oaymwEgCNACELwBSFXyq4qpAxIIARUAAIhCGAFwAcABBrgC8xg=&rs=AOn4CLB1O9sjwkfsmjOvuR2hP0qvN9ZXFg
                        thumbnails:
                          - url: >-
                              https://i.ytimg.com/vi/0e3GPea1Tyg/hqdefault.jpg?sqp=-oaymwEgCNACELwBSFXyq4qpAxIIARUAAIhCGAFwAcABBrgC8xg=&rs=AOn4CLB1O9sjwkfsmjOvuR2hP0qvN9ZXFg
                            width: 336
                            height: 188
                          - url: >-
                              https://i.ytimg.com/vi/0e3GPea1Tyg/hqdefault.jpg?sqp=-oaymwEgCPYBEIoBSFXyq4qpAxIIARUAAIhCGAFwAcABBrgC8xg=&rs=AOn4CLCcnVbWoo5J0ABJHgn0oZ6gDINJPg
                            width: 246
                            height: 138
                          - url: >-
                              https://i.ytimg.com/vi/0e3GPea1Tyg/hqdefault.jpg?sqp=-oaymwEfCMQBEG5IVfKriqkDEggBFQAAiEIYAXABwAEGuALzGA==&rs=AOn4CLDegZWMhGR3Ca4KfKLrpWaW2Kd02g
                            width: 196
                            height: 110
                        previewUrl: >-
                          https://i.ytimg.com/an_webp/0e3GPea1Tyg/mqdefault_6s.webp?du=3000&sqp=CPjCqNcG&rs=AOn4CLCdwhJcZFzmDP2amvcz6D1zSlcWgg
                        position: 1
                      - type: video
                        id: 2isYuQZMbdU
                        url: https://www.youtube.com/watch?v=2isYuQZMbdU
                        title: 100 People Fight For A Private Island
                        descriptionSnippet: >-
                          🚀Launch a store on Shopify, I’ll buy from 100 random
                          stores that do ▸ https://shopify.com/mrbeast


                          SUB TO ALL CHANNELS

                          www.youtube.com/@UCX6OQ3DkcsbYNE6H8uQQuVA

                          www.youtube.com/@UC4-79UOlP48...
                        viewCount: 265495494
                        viewCountText: 265,495,494 views
                        concurrentViewers: null
                        publishedText: 4 years ago
                        wasLive: false
                        durationSeconds: 931
                        durationText: '15:31'
                        badges:
                          - CC
                        channelId: UCX6OQ3DkcsbYNE6H8uQQuVA
                        channelName: MrBeast
                        channelHandle: MrBeast
                        isChannelVerified: true
                        thumbnailUrl: >-
                          https://i.ytimg.com/vi/2isYuQZMbdU/hqdefault.jpg?sqp=-oaymwEgCNACELwBSFXyq4qpAxIIARUAAIhCGAFwAcABBrgC8xg=&rs=AOn4CLBSB5iMjDtDiWT34IZ3Bh-D__IDDg
                        thumbnails:
                          - url: >-
                              https://i.ytimg.com/vi/2isYuQZMbdU/hqdefault.jpg?sqp=-oaymwEgCNACELwBSFXyq4qpAxIIARUAAIhCGAFwAcABBrgC8xg=&rs=AOn4CLBSB5iMjDtDiWT34IZ3Bh-D__IDDg
                            width: 336
                            height: 188
                          - url: >-
                              https://i.ytimg.com/vi/2isYuQZMbdU/hqdefault.jpg?sqp=-oaymwEgCPYBEIoBSFXyq4qpAxIIARUAAIhCGAFwAcABBrgC8xg=&rs=AOn4CLAW1V_jtibbtVKyrcLxXlwGN6BOnA
                            width: 246
                            height: 138
                          - url: >-
                              https://i.ytimg.com/vi/2isYuQZMbdU/hqdefault.jpg?sqp=-oaymwEfCMQBEG5IVfKriqkDEggBFQAAiEIYAXABwAEGuALzGA==&rs=AOn4CLAXtg_PzDthhD7dMi__QFJVnw92Yw
                            width: 196
                            height: 110
                        previewUrl: >-
                          https://i.ytimg.com/an_webp/2isYuQZMbdU/mqdefault_6s.webp?du=3000&sqp=CN2oqNcG&rs=AOn4CLAnS3WfR19YItjuDiwPagc5Ir0ZgA
                        position: 3
                      - type: video
                        id: sF5LYGgKbUA
                        url: https://www.youtube.com/watch?v=sF5LYGgKbUA
                        title: Every Minute One Person Is Eliminated
                        descriptionSnippet: >-
                          Watch Beast Games now on Prime Video:
                          https://linktr.ee/beastgames AmazonPrimePartner ad 


                          SUB TO ALL CHANNELS

                          www.youtube.com/@UCX6OQ3DkcsbYNE6H8uQQuVA

                          www.youtube.com/@UC4-79UOlP48-QNGgCko5p2g...
                        viewCount: 186995288
                        viewCountText: 186,995,288 views
                        concurrentViewers: null
                        publishedText: 1 year ago
                        wasLive: false
                        durationSeconds: 2086
                        durationText: '34:46'
                        badges:
                          - CC
                        channelId: UCX6OQ3DkcsbYNE6H8uQQuVA
                        channelName: MrBeast
                        channelHandle: MrBeast
                        isChannelVerified: true
                        thumbnailUrl: >-
                          https://i.ytimg.com/vi/sF5LYGgKbUA/hqdefault.jpg?sqp=-oaymwEgCNACELwBSFXyq4qpAxIIARUAAIhCGAFwAcABBrgC8xg=&rs=AOn4CLDdQ712ZMF62MMJdhnOfKSpGXiPbg
                        thumbnails:
                          - url: >-
                              https://i.ytimg.com/vi/sF5LYGgKbUA/hqdefault.jpg?sqp=-oaymwEgCNACELwBSFXyq4qpAxIIARUAAIhCGAFwAcABBrgC8xg=&rs=AOn4CLDdQ712ZMF62MMJdhnOfKSpGXiPbg
                            width: 336
                            height: 188
                          - url: >-
                              https://i.ytimg.com/vi/sF5LYGgKbUA/hqdefault.jpg?sqp=-oaymwEgCPYBEIoBSFXyq4qpAxIIARUAAIhCGAFwAcABBrgC8xg=&rs=AOn4CLADKj4sj0uTOESb9qtBCHXmfwSWpA
                            width: 246
                            height: 138
                          - url: >-
                              https://i.ytimg.com/vi/sF5LYGgKbUA/hqdefault.jpg?sqp=-oaymwEfCMQBEG5IVfKriqkDEggBFQAAiEIYAXABwAEGuALzGA==&rs=AOn4CLAi-leEzBuZpLDUVtkx6BCvqf7i9Q
                            width: 196
                            height: 110
                        previewUrl: >-
                          https://i.ytimg.com/an_webp/sF5LYGgKbUA/mqdefault_6s.webp?du=3000&sqp=CKCYqNcG&rs=AOn4CLBBsIPZDkJcyzKXF5xaPVDavA8EsQ
                        position: 4
                    shorts:
                      - type: short
                        id: DBw0oD38z0Q
                        url: https://www.youtube.com/shorts/DBw0oD38z0Q
                        title: This Game Is Wild
                        descriptionSnippet: null
                        viewCount: 243248747
                        viewCountText: 243,248,747 views
                        concurrentViewers: null
                        publishedText: 2 years ago
                        wasLive: false
                        durationSeconds: 21
                        durationText: '0:21'
                        badges: []
                        channelId: UCX6OQ3DkcsbYNE6H8uQQuVA
                        channelName: MrBeast
                        channelHandle: MrBeast
                        isChannelVerified: true
                        thumbnailUrl: >-
                          https://i.ytimg.com/vi/DBw0oD38z0Q/hqdefault.jpg?sqp=-oaymwE6CNACELwBSFXyq4qpAywIARUAAIhCGABwAcABBvABAfgBtgiAAoAPigIMCAAQARhlIFQoTzAPuALzGA==&rs=AOn4CLC7nAEMjEuLOLnsvaMUXH6xLSW1EQ
                        thumbnails:
                          - url: >-
                              https://i.ytimg.com/vi/DBw0oD38z0Q/hqdefault.jpg?sqp=-oaymwE6CNACELwBSFXyq4qpAywIARUAAIhCGABwAcABBvABAfgBtgiAAoAPigIMCAAQARhlIFQoTzAPuALzGA==&rs=AOn4CLC7nAEMjEuLOLnsvaMUXH6xLSW1EQ
                            width: 336
                            height: 188
                          - url: >-
                              https://i.ytimg.com/vi/DBw0oD38z0Q/hqdefault.jpg?sqp=-oaymwE6CPYBEIoBSFXyq4qpAywIARUAAIhCGABwAcABBvABAfgBtgiAAoAPigIMCAAQARhlIFQoTzAPuALzGA==&rs=AOn4CLAYNDUkCa-lh-0ktwjyaxV3x5bK9w
                            width: 246
                            height: 138
                          - url: >-
                              https://i.ytimg.com/vi/DBw0oD38z0Q/hqdefault.jpg?sqp=-oaymwE5CMQBEG5IVfKriqkDLAgBFQAAiEIYAHABwAEG8AEB-AG2CIACgA-KAgwIABABGGUgVChPMA-4AvMY&rs=AOn4CLCSliW1MXUcj9PK7fS1kUVTSDSP5w
                            width: 196
                            height: 110
                        previewUrl: >-
                          https://i.ytimg.com/an_webp/DBw0oD38z0Q/mqdefault_6s.webp?du=3000&sqp=CLSsqNcG&rs=AOn4CLBIBCQ-V-qXIIrrmIrK16qrws9P3g
                        position: 2
                      - type: short
                        id: I9mw5UlDyPI
                        url: https://www.youtube.com/shorts/I9mw5UlDyPI
                        title: This Game Is Wild...
                        descriptionSnippet: null
                        viewCount: 782150686
                        viewCountText: 782,150,686 views
                        concurrentViewers: null
                        publishedText: 1 year ago
                        wasLive: false
                        durationSeconds: 19
                        durationText: '0:19'
                        badges: []
                        channelId: UCX6OQ3DkcsbYNE6H8uQQuVA
                        channelName: MrBeast
                        channelHandle: MrBeast
                        isChannelVerified: true
                        thumbnailUrl: >-
                          https://i.ytimg.com/vi/I9mw5UlDyPI/hqdefault.jpg?sqp=-oaymwE6CNACELwBSFXyq4qpAywIARUAAIhCGABwAcABBvABAfgBtgiAAoAPigIMCAAQARhlIFQoRzAPuALzGA==&rs=AOn4CLDSBA9g1v7IDR7CravjasJJoPzhcw
                        thumbnails:
                          - url: >-
                              https://i.ytimg.com/vi/I9mw5UlDyPI/hqdefault.jpg?sqp=-oaymwE6CNACELwBSFXyq4qpAywIARUAAIhCGABwAcABBvABAfgBtgiAAoAPigIMCAAQARhlIFQoRzAPuALzGA==&rs=AOn4CLDSBA9g1v7IDR7CravjasJJoPzhcw
                            width: 336
                            height: 188
                          - url: >-
                              https://i.ytimg.com/vi/I9mw5UlDyPI/hqdefault.jpg?sqp=-oaymwE6CPYBEIoBSFXyq4qpAywIARUAAIhCGABwAcABBvABAfgBtgiAAoAPigIMCAAQARhlIFQoRzAPuALzGA==&rs=AOn4CLDQuB5YH13YoomNhSVdvb69IiAauA
                            width: 246
                            height: 138
                          - url: >-
                              https://i.ytimg.com/vi/I9mw5UlDyPI/hqdefault.jpg?sqp=-oaymwE5CMQBEG5IVfKriqkDLAgBFQAAiEIYAHABwAEG8AEB-AG2CIACgA-KAgwIABABGGUgVChHMA-4AvMY&rs=AOn4CLAzLht2nDVYCFYEP3OYHMiBsjBw3g
                            width: 196
                            height: 110
                        previewUrl: >-
                          https://i.ytimg.com/an_webp/I9mw5UlDyPI/mqdefault_6s.webp?du=3000&sqp=COKqqNcG&rs=AOn4CLAOKyKPvPx7aIPm_zykD7_y-MW2gQ
                        position: 5
                      - type: short
                        id: wSh8fAFWEWs
                        url: https://www.youtube.com/shorts/wSh8fAFWEWs
                        title: Survivor vs Beast Games
                        descriptionSnippet: null
                        viewCount: 41436103
                        viewCountText: 41,436,103 views
                        concurrentViewers: null
                        publishedText: 9 months ago
                        wasLive: false
                        durationSeconds: 28
                        durationText: '0:28'
                        badges: []
                        channelId: UCX6OQ3DkcsbYNE6H8uQQuVA
                        channelName: MrBeast
                        channelHandle: MrBeast
                        isChannelVerified: true
                        thumbnailUrl: >-
                          https://i.ytimg.com/vi/wSh8fAFWEWs/hqdefault.jpg?sqp=-oaymwE6CNACELwBSFXyq4qpAywIARUAAIhCGABwAcABBvABAfgBtgiAAoAPigIMCAAQARhZIGUoQjAPuALzGA==&rs=AOn4CLAtERaGNTABMqd027uzHPhwU0Yogw
                        thumbnails:
                          - url: >-
                              https://i.ytimg.com/vi/wSh8fAFWEWs/hqdefault.jpg?sqp=-oaymwE6CNACELwBSFXyq4qpAywIARUAAIhCGABwAcABBvABAfgBtgiAAoAPigIMCAAQARhZIGUoQjAPuALzGA==&rs=AOn4CLAtERaGNTABMqd027uzHPhwU0Yogw
                            width: 336
                            height: 188
                          - url: >-
                              https://i.ytimg.com/vi/wSh8fAFWEWs/hqdefault.jpg?sqp=-oaymwE6CPYBEIoBSFXyq4qpAywIARUAAIhCGABwAcABBvABAfgBtgiAAoAPigIMCAAQARhZIGUoQjAPuALzGA==&rs=AOn4CLDiyzfeSfJqqBRS3gyRRTXenV5ydQ
                            width: 246
                            height: 138
                          - url: >-
                              https://i.ytimg.com/vi/wSh8fAFWEWs/hqdefault.jpg?sqp=-oaymwE5CMQBEG5IVfKriqkDLAgBFQAAiEIYAHABwAEG8AEB-AG2CIACgA-KAgwIABABGFkgZShCMA-4AvMY&rs=AOn4CLA6ObFo55voYb_59NzTLi4W77s9GQ
                            width: 196
                            height: 110
                        previewUrl: >-
                          https://i.ytimg.com/an_webp/wSh8fAFWEWs/mqdefault_6s.webp?du=3000&sqp=CN2oqNcG&rs=AOn4CLAZqgG2SXCU3m5EnRWICyIjyKEcdw
                        position: 6
                    lives: []
                    playlists: []
                    podcasts: []
                    shows: []
                  counts:
                    videos: 9
                    shorts: 20
                    lives: 0
                    playlists: 0
                    podcasts: 0
                    shows: 0
                  count: 29
                  cursor: >-
                    eyJoIjoibXJiZWFzdCIsInEiOiJzcXVpZCBnYW1lIiwiYyI6IjRxbUZzZ0o2RWhoVlExZzJUMUV6Ukd0amMySlpUa1UyU0RoMVVWRjFWa0VhSmtOQ01GTkNiazVzV1ZoS2FtRkVRVUpQUVVablFWZHZRV1ZuVGtoUmFsTTBRVkZCSlRORVdncHpjWFZwWkNCbllXMWxtZ0lwWW5KdmQzTmxMV1psWldSVlExZzJUMUV6Ukd0amMySlpUa1UyU0RoMVVWRjFWa0Z6WldGeVkyZyUzRCIsImNoIjp7ImlkIjoiVUNYNk9RM0RrY3NiWU5FNkg4dVFRdVZBIiwiaGFuZGxlIjoiTXJCZWFzdCIsIm5hbWUiOiJNckJlYXN0IiwidXJsIjoiaHR0cHM6Ly93d3cueW91dHViZS5jb20vQE1yQmVhc3QiLCJhdmF0YXJVcmwiOiJodHRwczovL3l0My5nb29nbGV1c2VyY29udGVudC5jb20vbnhZcmNfMV8yZjc3RG9CYWR5eE1UbXY3WnBSWmFwSFI1amJ1WWU3UGxQZDVjSVJKeHROTkVZeU9DMFpzeGFEeUpKelhybkppdURFPXM5MDAtYy1rLWMweDAwZmZmZmZmLW5vLXJqIiwiaXNWZXJpZmllZCI6dHJ1ZSwic3Vic2NyaWJlckNvdW50Ijo1MjUwMDAwMDB9fQ
                  hasMore: true
                  fetchedAt: '2026-11-03T18:46:48.112Z'
                meta:
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
                  creditsCharged: 1
                  creditsRemaining: 4999
                  cached: false
        '400':
          description: Invalid or expired cursor (or one for another handle or query).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: BAD_REQUEST
                  message: The request was invalid.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '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 YouTube channel found (it may not exist or have been removed).
          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 (handle and query are required).
          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: url is 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 <key>`). Create and manage keys from your dashboard.

````

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