# 综合搜索（原始数据，推荐使用V2）/General search (raw data, recommend V2)

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/youtube/web_v2/get_general_search:
    get:
      summary: 综合搜索（原始数据，推荐使用V2）/General search (raw data, recommend V2)
      deprecated: false
      description: >-
        # [中文]

        ### ⚠️ 推荐使用 V2 版本:

        - 本接口返回 YouTube 原始数据结构，需要自行解析

        - **清洗过的数据版本请使用 `/get_general_search_v2` 接口**，返回结构化的视频、Shorts、频道、播放列表数据


        ### 用途:

        - YouTube综合搜索，支持多种过滤条件，可以精确筛选搜索结果


        ### 参数详解:

        - **search_query**: 搜索关键字

        - **language_code**: 语言代码，推荐使用zh-CN（中文）或en-US（英文）

        - **country_code**: 国家代码，影响搜索结果的地区相关性

        - **time_zone**: 时区设置


        ### 过滤条件 (选择一个值即可):

        #### 上传时间 (upload_time):

        - `hour`: 过去1小时内上传

        - `today`: 今天上传

        - `week`: 本周上传

        - `month`: 本月上传

        - `year`: 今年上传


        #### 视频时长 (duration):

        - `short`: 短视频（少于4分钟）

        - `medium`: 中等时长（4-20分钟）

        - `long`: 长视频（超过20分钟）


        #### 内容类型 (content_type):

        - `video`: 视频

        - `channel`: 频道

        - `playlist`: 播放列表

        - `movie`: 电影


        #### 特征 (feature):

        - `hd`: 高清视频

        - `4k`: 4K视频

        - `subtitles`: 包含字幕

        - `live`: 直播

        - `creative_commons`: 知识共享许可

        - `360`: 360度视频

        - `vr180`: VR180视频

        - `3d`: 3D视频

        - `hdr`: HDR视频

        - `location`: 包含位置信息

        - `purchased`: 已购买内容


        #### 排序方式 (sort_by):

        - `relevance`: 相关性（默认）

        - `upload_date`: 上传日期

        - `view_count`: 观看次数

        - `rating`: 评分


        ### 返回:

        - 包含过滤条件的搜索结果


        # [English]

        ### Purpose:

        - YouTube comprehensive search with multiple filter options for precise
        result filtering


        ### Parameters:

        - **search_query**: Search keyword

        - **language_code**: Language code (zh-CN for Chinese, en-US for
        English)

        - **country_code**: Country code affecting regional relevance

        - **time_zone**: Time zone setting


        ### Filter Options (select one value for each):

        #### Upload Time (upload_time):

        - `hour`: Uploaded in the past hour

        - `today`: Uploaded today

        - `week`: Uploaded this week

        - `month`: Uploaded this month

        - `year`: Uploaded this year


        #### Duration (duration):

        - `short`: Short videos (under 4 minutes)

        - `medium`: Medium length (4-20 minutes)

        - `long`: Long videos (over 20 minutes)


        #### Content Type (content_type):

        - `video`: Videos

        - `channel`: Channels

        - `playlist`: Playlists

        - `movie`: Movies


        #### Features (feature):

        - `hd`: High definition

        - `4k`: 4K videos

        - `subtitles`: With subtitles

        - `live`: Live streams

        - `creative_commons`: Creative Commons licensed

        - `360`: 360-degree videos

        - `vr180`: VR180 videos

        - `3d`: 3D videos

        - `hdr`: HDR videos

        - `location`: With location info

        - `purchased`: Purchased content


        #### Sort By (sort_by):

        - `relevance`: Relevance (default)

        - `upload_date`: Upload date

        - `view_count`: View count

        - `rating`: Rating


        ### ⚠️ Recommend using V2 version:

        - This endpoint returns raw YouTube data structure that requires manual
        parsing

        - **For cleaned/structured data, use `/get_general_search_v2`
        endpoint**, which returns structured videos, Shorts, channels, and
        playlists data


        ### Returns:

        - Filtered search results


        # [示例/Examples]

        ## 基础搜索

        GET /youtube_web/get_general_search?search_query=Python编程


        ## 搜索本周上传的Python编程短视频

        GET
        /youtube_web/get_general_search?search_query=Python编程&upload_time=week&duration=short


        ## 搜索高清的Python教程视频，按观看次数排序

        GET /youtube_web/get_general_search?search_query=Python
        tutorial&feature=hd&sort_by=view_count


        ## 搜索今天上传的4K编程直播

        GET
        /youtube_web/get_general_search?search_query=programming&upload_time=today&feature=4k&content_type=video
      operationId: get_general_search_api_v1_youtube_web_v2_get_general_search_get
      tags:
        - YouTube-Web-V2-API
        - YouTube-Web-V2-API
      parameters:
        - name: search_query
          in: query
          description: 搜索关键字/Search keyword
          required: true
          example: Python编程
          schema:
            type: string
            maxLength: 200
            description: 搜索关键字/Search keyword
            title: Search Query
        - name: language_code
          in: query
          description: 语言代码（如zh-CN, en-US等）/Language code
          required: false
          schema:
            type: string
            description: 语言代码（如zh-CN, en-US等）/Language code
            default: zh-CN
            title: Language Code
        - name: country_code
          in: query
          description: 国家代码（如US, CN等）/Country code
          required: false
          schema:
            type: string
            description: 国家代码（如US, CN等）/Country code
            default: US
            title: Country Code
        - name: time_zone
          in: query
          description: 时区（如America/Los_Angeles, Asia/Shanghai等）/Time zone
          required: false
          schema:
            type: string
            description: 时区（如America/Los_Angeles, Asia/Shanghai等）/Time zone
            default: America/Los_Angeles
            title: Time Zone
        - name: upload_time
          in: query
          description: 上传时间过滤 | Upload time filter
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/YouTubeUploadTimeAPI'
              - type: 'null'
            description: 上传时间过滤 | Upload time filter
            examples:
              hour:
                summary: 过去1小时
                value: hour
              today:
                summary: 今天
                value: today
              week:
                summary: 本周
                value: week
              month:
                summary: 本月
                value: month
              year:
                summary: 今年
                value: year
            title: Upload Time
        - name: duration
          in: query
          description: 视频时长过滤 | Duration filter
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/YouTubeDurationAPI'
              - type: 'null'
            description: 视频时长过滤 | Duration filter
            examples:
              short:
                summary: 短视频 (<4分钟)
                value: short
              medium:
                summary: 中等时长 (4-20分钟)
                value: medium
              long:
                summary: 长视频 (>20分钟)
                value: long
            title: Duration
        - name: content_type
          in: query
          description: 内容类型过滤 | Content type filter
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/YouTubeContentTypeAPI'
              - type: 'null'
            description: 内容类型过滤 | Content type filter
            examples:
              video:
                summary: 视频
                value: video
              channel:
                summary: 频道
                value: channel
              playlist:
                summary: 播放列表
                value: playlist
              movie:
                summary: 电影
                value: movie
            title: Content Type
        - name: feature
          in: query
          description: 特征过滤 | Feature filter
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/YouTubeFeatureAPI'
              - type: 'null'
            description: 特征过滤 | Feature filter
            examples:
              '360':
                summary: 360度
                value: '360'
              hd:
                summary: 高清
                value: hd
              4k:
                summary: 4K
                value: 4k
              subtitles:
                summary: 字幕
                value: subtitles
              live:
                summary: 直播
                value: live
              creative_commons:
                summary: 知识共享
                value: creative_commons
              vr180:
                summary: VR180
                value: vr180
              3d:
                summary: 3D
                value: 3d
              hdr:
                summary: HDR
                value: hdr
              location:
                summary: 位置
                value: location
              purchased:
                summary: 已购买
                value: purchased
            title: Feature
        - name: sort_by
          in: query
          description: 排序方式 | Sort by
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/YouTubeSearchSortAPI'
              - type: 'null'
            description: 排序方式 | Sort by
            examples:
              relevance:
                summary: 相关性
                value: relevance
              upload_date:
                summary: 上传日期
                value: upload_date
              view_count:
                summary: 观看次数
                value: view_count
              rating:
                summary: 评分
                value: rating
            title: Sort By
        - name: continuation_token
          in: query
          description: 翻页令牌/Pagination token
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: 翻页令牌/Pagination token
            title: Continuation Token
      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: F_43KltTnKmbk8n4d-Ml9
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: F_43KltTnKmbk8n4d-Ml9
            scopes:
              F_43KltTnKmbk8n4d-Ml9:
                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-419083085-run
components:
  schemas:
    YouTubeUploadTimeAPI:
      type: string
      enum:
        - hour
        - today
        - week
        - month
        - year
      title: YouTubeUploadTimeAPI
      description: YouTube上传时间过滤 - API显示版本
      x-apifox-folder: ''
    YouTubeDurationAPI:
      type: string
      enum:
        - short
        - medium
        - long
      title: YouTubeDurationAPI
      description: YouTube视频时长过滤 - API显示版本
      x-apifox-folder: ''
    YouTubeContentTypeAPI:
      type: string
      enum:
        - video
        - channel
        - playlist
        - movie
      title: YouTubeContentTypeAPI
      description: YouTube内容类型过滤 - API显示版本
      x-apifox-folder: ''
    YouTubeFeatureAPI:
      type: string
      enum:
        - live
        - 4k
        - hd
        - subtitles
        - creative_commons
        - '360'
        - vr180
        - 3d
        - hdr
        - location
        - purchased
      title: YouTubeFeatureAPI
      description: YouTube特征过滤 - API显示版本
      x-apifox-folder: ''
    YouTubeSearchSortAPI:
      type: string
      enum:
        - relevance
        - upload_date
        - view_count
        - rating
      title: YouTubeSearchSortAPI
      description: YouTube搜索排序方式 - API显示版本
      x-apifox-folder: ''
    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: []

```
