# 搜索频道/Search channels

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/youtube/web_v2/search_channels:
    get:
      summary: 搜索频道/Search channels
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 搜索YouTube频道

        - 只返回频道类型的搜索结果（过滤掉视频、播放列表等）

        - 支持分页获取更多频道


        ### 参数:

        - keyword: 搜索关键词（首次请求必填）

        - continuation_token: 分页token（可选，用于获取下一页）

        - need_format: 是否格式化数据（默认 true）
          - true: 返回格式化的结构化数据（推荐）
          - false: 返回原始的 YouTube API 结构（用于调试）

        ### 返回数据包含:

        #### 当 need_format=true 时:

        - keyword: 搜索关键词

        - channels: 频道列表
          - channel_id: 频道ID（如 "UCjuNibFJ21MiSNpu8LZyV4w"）
          - title: 频道名称
          - handle: 频道自定义handle（如 "@chaijing2023"）
          - subscriber_count_text: 订阅者数量文本（如 "1.11M subscribers"）
          - description: 频道描述片段
          - thumbnails: 缩略图列表（包含不同尺寸）
          - is_subscribed: 当前用户是否已订阅该频道（布尔值）
          - canonical_url: 频道规范URL路径（如 "/@chaijing2023"）
          - channel_url: 频道完整URL（优先使用自定义URL）
        - continuation_token: 下一页的分页token

        - has_more: 是否还有更多频道

        - total_count: 当前页频道数量


        #### 当 need_format=false 时:

        - keyword: 搜索关键词

        - channels: 原始的 channelRenderer 对象列表

        - continuation_token: 下一页的分页token

        - has_more: 是否还有更多频道

        - total_count: 当前页频道数量


        ### 使用流程:

        1. 首次请求：只传 keyword 参数

        2. 获取响应中的 continuation_token

        3. 下次请求：传入 continuation_token（keyword 可选）

        4. 重复步骤 2-3 直到 has_more 为 false


        ### 注意事项:

        - 每页通常返回 10-20 个频道

        - 搜索结果只包含频道，不包含视频、播放列表等

        - 搜索结果的顺序和数量由 YouTube 算法决定


        ### 价格:

        - $0.001 USD / 请求


        # [English]

        ### Purpose:

        - Search YouTube channels

        - Only returns channel-type search results (filters out videos,
        playlists, etc.)

        - Supports pagination to get more channels


        ### Parameters:

        - keyword: Search keyword (required for first request)

        - continuation_token: Pagination token (optional, for next page)

        - need_format: Whether to format data (default true)
          - true: Return formatted structured data (recommended)
          - false: Return raw YouTube API structure (for debugging)

        ### Returns:

        #### When need_format=true:

        - keyword: Search keyword

        - channels: Channels list
          - channel_id: Channel ID (e.g., "UCjuNibFJ21MiSNpu8LZyV4w")
          - title: Channel name
          - handle: Channel custom handle (e.g., "@chaijing2023")
          - subscriber_count_text: Subscriber count text (e.g., "1.11M subscribers")
          - description: Channel description snippet
          - thumbnails: Thumbnail list (multiple sizes)
          - is_subscribed: Whether current user is subscribed to this channel (boolean)
          - canonical_url: Channel canonical URL path (e.g., "/@chaijing2023")
          - channel_url: Full channel URL (prefers custom URL)
        - continuation_token: Next page pagination token

        - has_more: Whether there are more channels

        - total_count: Current page channel count


        #### When need_format=false:

        - keyword: Search keyword

        - channels: Raw channelRenderer object list

        - continuation_token: Next page pagination token

        - has_more: Whether there are more channels

        - total_count: Current page channel count


        ### Usage Flow:

        1. First request: Only pass keyword parameter

        2. Get continuation_token from response

        3. Next request: Pass continuation_token (keyword optional)

        4. Repeat steps 2-3 until has_more is false


        ### Notes:

        - Each page typically returns 10-20 channels

        - Search results only include channels, not videos, playlists, etc.

        - Order and quantity of results determined by YouTube algorithm


        ### Price:

        - $0.001 USD / request


        ### [示例/Example]

        #### 搜索频道: keyword = "Rick Astley"
      operationId: search_channels_api_v1_youtube_web_v2_search_channels_get
      tags:
        - YouTube-Web-V2-API
        - YouTube-Web-V2-API
      parameters:
        - name: keyword
          in: query
          description: 搜索关键词/Search keyword
          required: false
          example: Rick Astley
          schema:
            anyOf:
              - type: string
                maxLength: 200
              - type: 'null'
            description: 搜索关键词/Search keyword
            title: Keyword
        - name: continuation_token
          in: query
          description: 分页token/Pagination token
          required: false
          schema:
            type: string
            description: 分页token/Pagination token
            title: Continuation Token
        - name: need_format
          in: query
          description: 是否格式化数据/Whether to format data
          required: false
          schema:
            type: boolean
            description: 是否格式化数据/Whether to format data
            default: true
            title: Need Format
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseModel'
          headers: {}
          x-apifox-name: OK
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          headers: {}
          x-apifox-name: Unprocessable Entity
      security:
        - HTTPBearer: []
          x-apifox:
            schemeGroups:
              - id: jt3X2yS2tWpmtgRqeV20l
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: jt3X2yS2tWpmtgRqeV20l
            scopes:
              jt3X2yS2tWpmtgRqeV20l:
                HTTPBearer: []
      x-apifox-folder: YouTube-Web-V2-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-419083096-run
components:
  schemas:
    ResponseModel:
      properties:
        code:
          type: integer
          title: Code
          description: HTTP status code | HTTP状态码
          default: 200
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: Unique request identifier | 唯一请求标识符
        message:
          type: string
          title: Message
          description: Response message (EN-US) | 响应消息 (English)
          default: Request successful. This request will incur a charge.
        message_zh:
          type: string
          title: Message Zh
          description: Response message (ZH-CN) | 响应消息 (中文)
          default: 请求成功，本次请求将被计费。
        support:
          type: string
          title: Support
          description: Support message | 支持消息
          default: 'Discord: https://discord.gg/aMEAS8Xsvz'
        time:
          type: string
          title: Time
          description: The time the response was generated | 生成响应的时间
        time_stamp:
          type: integer
          title: Time Stamp
          description: The timestamp the response was generated | 生成响应的时间戳
        time_zone:
          type: string
          title: Time Zone
          description: The timezone of the response time | 响应时间的时区
          default: America/Los_Angeles
        docs:
          anyOf:
            - type: string
            - type: 'null'
          title: Docs
          description: >-
            Link to the API Swagger documentation for this endpoint | 此端点的 API
            Swagger 文档链接
        cache_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Message
          description: Cache message (EN-US) | 缓存消息 (English)
          default: >-
            This response is cached and accessible via the URL below for 24
            hours at no extra cost. The cache is for request tracing only — it
            doesn't affect the API's data freshness and won't be returned
            through the API again.
        cache_message_zh:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Message Zh
          description: Cache message (ZH-CN) | 缓存消息 (中文)
          default: >-
            本次响应已缓存，可通过下方 URL 直接查看，有效期 24
            小时，访问缓存链接无额外费用。缓存仅用于请求溯源，不影响接口数据的时效性，也不会再次通过接口返回。
        cache_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Url
          description: The URL to access the cached result | 访问缓存结果的 URL
        router:
          type: string
          title: Router
          description: The endpoint that generated this response | 生成此响应的端点
          default: ''
        params:
          type: string
        data:
          anyOf:
            - type: string
            - type: 'null'
          title: Data
          description: The response data | 响应数据
      type: object
      title: ResponseModel
      x-apifox-orders:
        - code
        - request_id
        - message
        - message_zh
        - support
        - time
        - time_stamp
        - time_zone
        - docs
        - cache_message
        - cache_message_zh
        - cache_url
        - router
        - params
        - data
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
      x-apifox-orders:
        - detail
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
      x-apifox-orders:
        - loc
        - msg
        - type
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
  securitySchemes:
    HTTPBearer:
      type: bearer
      description: >
        ----

        #### API Token Introduction:

        ##### Method 1: Use API Token in the Request Header (Recommended)

        - **Header**: `Authorization`

        - **Format**: `Bearer {token}`

        - **Example**: `{"Authorization": "Bearer your_token"}`

        - **Swagger UI**: Click on the `Authorize` button in the upper right
        corner of the page to enter the API token directly without the `Bearer`
        keyword.


        ##### Method 2: Use API Token in the Cookie (Not Recommended, Use Only
        When Method 1 is Unavailable)

        - **Cookie**: `Authorization`

        - **Format**: `Bearer {token}`

        - **Example**: `Authorization=Bearer your_token`


        #### Get API Token:

        1. Register and log in to your account on the TikHub website.

        2. Go to the user center, click on the API token menu, and create an API
        token.

        3. Copy and use the API token in the request header.

        4. Keep your API token confidential and use it only in the request
        header.


        ----


        #### API令牌简介:

        ##### 方法一：在请求头中使用API令牌（推荐）

        - **请求头**: `Authorization`

        - **格式**: `Bearer {token}`

        - **示例**: `{"Authorization": "Bearer your_token"}`

        - **Swagger UI**: 点击页面右上角的`Authorize`按钮，直接输入API令牌，不需要`Bearer`关键字。


        ##### 方法二：在Cookie中使用API令牌（不推荐，仅在无法使用方法一时使用）

        - **Cookie**: `Authorization`

        - **格式**: `Bearer {token}`

        - **示例**: `Authorization=Bearer your_token`


        #### 获取API令牌:

        1. 在TikHub网站注册并登录账户。

        2. 进入用户中心，点击API令牌菜单，创建API令牌。

        3. 复制并在请求头中使用API令牌。

        4. 保密您的API令牌，仅在请求头中使用。
      scheme: bearer
servers:
  - url: https://api.tikhub.io
    description: Production Environment
security: []

```