> ## 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. # YouTube channel search API > Search one channel's videos, like the search box on its YouTube page. Call the YouTube channel search API for JSON. 1 credit per call. Searches one channel's videos, equivalent to the search box on its YouTube page. The channel is identified by its URL or ID. ## Request `query` is required. Exactly one of `channelUrl` or `channelId` is required. A request that sets both, or none, fails with `invalidRequest`. ```typescript TypeScript icon="https://mintlify.s3.us-west-1.amazonaws.com/sirathic/images/icons/typescript.svg" theme={null} theme={null} import { Stophy } from "stophy"; const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY }); const result = await stophy.youtube.channel.search({ query: "elon musk", channelId: "@lexfridman" }); console.log(result.data.results); ``` ```python Python icon="python" theme={null} theme={null} from stophy import Stophy stophy = Stophy() # reads STOPHY_API_KEY result = stophy.youtube.channel.search(query="elon musk", channel_id="@lexfridman") print(result["data"]["results"]) ``` ```bash cURL icon="terminal" theme={null} theme={null} curl -X POST https://api.stophy.dev/v1/youtube/channel/search \ -H "Authorization: Bearer $STOPHY_API_KEY" \ -H "content-type: application/json" \ -d '{"query":"elon musk","channelId":"@lexfridman"}' ``` ```bash CLI icon="square-terminal" theme={null} theme={null} stophy youtube channel search "elon musk" --channelId @lexfridman ``` ## Response If successful, the response body contains the standard envelope. `data.results[]` contains the channel's videos that match the query. The following example is a real response, truncated: each list shows one item and long strings are cut. ```json theme={null} { "success": true, "data": { "results": [ { "type": "video", "videoId": "JN3KPFbWCy8", "videoUrl": "https://www.youtube.com/watch?v=JN3KPFbWCy8", "title": "Elon Musk: War, AI, Aliens, Politics, Physics, Video Games, and Humanity | Lex Fridman Podcast #400", "channelId": "UCSHZKyawb77ixDdsGog4iWA", "channelName": "Lex Fridman", "channelUrl": "https://www.youtube.com/channel/UCSHZKyawb77ixDdsGog4iWA", "channelUsername": "lexfridman", "durationSeconds": 8207, "views": 14306823, "thumbnailUrl": "https://i.ytimg.com/vi/JN3KPFbWCy8/hqdefault.jpg", "isShort": false, "isLive": false, "publishedAt": "2024-10-05T09:08:36.000Z" } ], "cursor": "4qmFsgJ5EhhVQ1NIWkt5YXdiNzdpeERkc0dvZzRpV0EaJkNCNFNCbk5sWVhKamFEQUJPQUZnQVdvQWVnTkhRalM0QVFBJTNEWgllbG9uIG11c2uaAilicm9…" }, "creditsUsed": 1, "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b" } ``` | Field | Type | Description | | - | - | - | | `cursor` | string | The pagination token. Pass it as `cursor` to retrieve the next page. Omitted on the last page. | | `type` | string | The kind of item: `video`. | | `publishedAt` | string (ISO 8601) | Approximate. YouTube lists show only how long ago a video was published. [YouTube video](/api-reference/endpoint/youtube-video) has the exact time. | | `durationSeconds` | integer | The duration, in seconds. | For every field, see the response schema on this page. ## Optional parameters | Parameter | Type | Description | | - | - | - | | `cursor` | string | The pagination token from the previous response. | ## Billing Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed. ## Pagination Results are paginated. To retrieve the next page, pass the value of `data.cursor` as `cursor` in a subsequent request. A response that omits `cursor` is the last page. ## Related methods * [YouTube channel](/api-reference/endpoint/youtube-channel): Accepts `channelUrl`. Returns a channel's profile and one tab of videos, shorts, live, playlists, podcasts or posts. * [YouTube transcript](/api-reference/endpoint/youtube-transcript): Accepts `videoUrl`. Returns what a YouTube video says, from its captions. * [YouTube video](/api-reference/endpoint/youtube-video): Accepts `videoUrl`. Returns a video's stats, description, chapters and most replayed moments. * [YouTube comments](/api-reference/endpoint/youtube-comments): Accepts `videoUrl`. Returns a video's comments, or the replies to one comment. ## OpenAPI ````yaml api-reference/openapi.json POST /v1/youtube/channel/search openapi: 3.1.0 info: title: Stophy API version: '1' description: >- Every endpoint is a POST that takes its input as a JSON object body. Unknown fields are rejected with 400. Responses leave out empty values: null, empty strings, empty objects and empty nested lists are not sent. x-credits is what one call costs. Every call costs the same, whatever it returns, unless an operation's description says it costs per 10 results, or per second of audio. Then x-credits is the lowest price and x-credits-max the most one call can cost. Where an operation takes limit, send it to return fewer results and pay for fewer. When a response has a cursor, send it back unchanged with the same input to get the next page. When it has a page, send the next page number. servers: - url: https://api.stophy.dev security: - apiKey: [] paths: /v1/youtube/channel/search: post: summary: Search one channel's videos, like the search box on its YouTube page description: Costs 1 credit per call. Pages with cursor. operationId: youtubeChannelSearch requestBody: required: true content: application/json: schema: type: object properties: query: type: string minLength: 1 maxLength: 200 channelUrl: type: string description: >- Link to the YouTube channel, like https://www.youtube.com/@mkbhd. Send this or channelId. channelId: type: string description: >- YouTube channel handle or id, like @mkbhd. Send this or channelUrl. cursor: type: string minLength: 1 description: The cursor from the previous response. Send it as is. required: - query sendOne: - channelUrl - channelId additionalProperties: false example: query: elon musk channelId: '@lexfridman' responses: '200': description: The data, and the credits this call used. headers: X-Request-ID: $ref: '#/components/headers/RequestId' x-credits-used: $ref: '#/components/headers/CreditsUsed' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' x-cache: $ref: '#/components/headers/Cache' x-cache-age: $ref: '#/components/headers/CacheAge' content: application/json: schema: type: object required: - success - data - creditsUsed - requestId properties: success: const: true data: type: object additionalProperties: false properties: results: type: array items: type: object additionalProperties: false properties: type: type: string const: video videoId: type: string videoUrl: type: string format: uri title: type: string channelId: type: string channelName: type: string channelUrl: type: string format: uri channelUsername: type: string durationSeconds: type: integer minimum: -9007199254740991 maximum: 9007199254740991 views: type: integer minimum: -9007199254740991 maximum: 9007199254740991 thumbnailUrl: type: string format: uri isShort: type: boolean isLive: type: boolean publishedAt: description: >- Approximate: YouTube lists show only how long ago a video was published. youtube.video has the exact time. type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - type - videoUrl - isShort - isLive cursor: type: string required: - results creditsUsed: type: integer requestId: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' components: headers: RequestId: description: The request id. Quote it when you report a problem. schema: type: string CreditsUsed: description: Credits this call used. schema: type: integer RateLimitLimit: description: Requests allowed in the current window. schema: type: integer RateLimitRemaining: description: Requests left in the current window. schema: type: integer RateLimitReset: description: Unix time in seconds when the current window resets. schema: type: integer Cache: description: hit if this result came from the cache, miss if it was fetched live. schema: type: string CacheAge: description: Seconds since the returned result was written to the cache. schema: type: integer RetryAfter: description: Seconds to wait before retrying. schema: type: integer responses: Error: description: The request failed. retryable says whether trying again can help. headers: X-Request-ID: $ref: '#/components/headers/RequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object required: - success - error properties: success: const: false error: type: object required: - code - message - retryable - requestId properties: code: type: string enum: - cliSessionCompleted - cliSessionExists - cliSessionNotFound - forbidden - insufficientCredits - internalError - inviteClaimed - inviteDisabled - inviteExpired - inviteUsedUp - invalidCliSession - invalidCliVerifier - invalidRequest - notFound - rateLimited - sourceChanged - sourceRefused - sourceTimeout - sourceUnavailable - tooManyInFlight - unauthorized - unsupportedMediaType message: type: string retryable: type: boolean retryAfterSeconds: type: integer requestId: type: string requiredCredits: type: number availableCredits: type: number billingUrl: type: string const: https://stophy.dev/billing securitySchemes: apiKey: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.