# 获取音乐搜索/Fetch music search

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/douyin/search/fetch_music_search:
    post:
      summary: 获取音乐搜索/Fetch music search
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取抖音 App 中音乐内容的搜索结果。

        - 支持关键词、排序方式、筛选条件等。


        ### 备注:

        - 本接口专注于音乐类内容搜索，不包含其他类型内容。

        - 初次请求时 `cursor` 传 0，`search_id` 传空字符串。

        - 返回内容包含音乐基本信息、作者信息、封面、播放地址、标签等。


        ### 参数:

        - keyword: 搜索关键词，例如 "游戏背景音乐"

        - cursor: 翻页游标（首次请求传 0，翻页时使用上次响应的 cursor）

        - sort_type: 排序方式
            - `0`: 综合排序
            - `1`: 最多点赞
            - `2`: 最新发布
        - publish_time: 发布时间筛选
            - `0`: 不限
            - `1`: 最近一天
            - `7`: 最近一周
            - `180`: 最近半年
        - filter_duration: 视频时长筛选
            - `0`: 不限
            - `0-1`: 1 分钟以内
            - `1-5`: 1-5 分钟
            - `5-10000`: 5 分钟以上
        - content_type: 内容类型筛选
            - `0`: 不限
            - `1`: 视频
            - `2`: 图片
            - `3`: 文章
        - search_id: 搜索ID（分页时使用）


        ### 请求体示例：

        ```json

        payload = {
            "keyword": "游戏背景音乐",
            "cursor": 0,
            "sort_type": "0",
            "publish_time": "0",
            "filter_duration": "0",
            "content_type": "0",
            "search_id": ""
        }

        ```


        ### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:

        - `music`: 音乐结果列表
          - `id_str`: 音乐ID（字符串格式）
          - `title`: 音乐标题
          - `author`: 音乐作者昵称
          - `album`: 所属专辑（如果有）
          - `play_url.url_list`: 音乐播放地址列表
          - `duration`: 音乐时长（秒）
          - `cover_thumb.url_list`: 缩略封面图片列表
          - `cover_medium.url_list`: 中尺寸封面图片列表
          - `cover_large.url_list`: 高清封面图片列表
          - `user_count`: 使用该音乐的作品数量
          - `is_original`: 是否原创音乐
          - `is_commerce_music`: 是否为商业授权音乐
          - `lyric_url`: 歌词文件链接（如果有）
          - `strong_beat_url.url_list`: 音乐节奏点文件链接
          - `tags`: 音乐标签
            - 如：主题（如游戏、Vlog）、情绪（如Funny）、风格（如8-bit, Electronic）
          - `artists`: 音乐关联的创作者列表（如果有）
            - `artist_name`: 艺人昵称
            - `uid`: 艺人UID
          - `cover_color_hsv`: 封面主色调HSV值
          - `can_background_play`: 是否支持后台播放

        # [English]

        ### Purpose:

        - Fetch music content search results from Douyin App.

        - Supports filtering by keyword, sort type, etc.


        ### Notes:

        - This API focuses on music content search, excluding other types.

        - Set `cursor` to 0 and `search_id` to an empty string for the first
        request.

        - Response includes music basic info, artist info, covers, play URLs,
        tags, etc.


        ### Parameters:

        - keyword: Search keyword, e.g., "game background music"

        - cursor: Pagination cursor (0 for first request)

        - sort_type: Sorting method
            - `0`: Comprehensive
            - `1`: Most likes
            - `2`: Latest
        - publish_time: Publish time filter
            - `0`: Unlimited
            - `1`: Last day
            - `7`: Last week
            - `180`: Last half year
        - filter_duration: Video duration filter
            - `0`: Unlimited
            - `0-1`: Under 1 minute
            - `1-5`: 1 to 5 minutes
            - `5-10000`: Over 5 minutes
        - content_type: Content type filter
            - `0`: Unlimited
            - `1`: Video
            - `2`: Image
            - `3`: Article
        - search_id: Search ID for pagination


        ### Request Body Example:

        ```json

        payload = {
            "keyword": "game background music",
            "cursor": 0,
            "sort_type": "0",
            "publish_time": "0",
            "filter_duration": "0",
            "content_type": "0",
            "search_id": ""
        }

        ```


        ### Response (common fields, actual response may contain more fields):

        - `music`: List of music search results
          - `id_str`: Music ID (as string)
          - `title`: Music title
          - `author`: Music author's nickname
          - `album`: Album name (if any)
          - `play_url.url_list`: List of music play URLs
          - `duration`: Duration in seconds
          - `cover_thumb.url_list`: List of thumbnail cover URLs
          - `cover_medium.url_list`: List of medium-sized cover URLs
          - `cover_large.url_list`: List of large-sized cover URLs
          - `user_count`: Number of videos using this music
          - `is_original`: Whether it is original music
          - `is_commerce_music`: Whether it is commercial music
          - `lyric_url`: Lyrics file URL (if available)
          - `strong_beat_url.url_list`: Beat timing file URLs
          - `tags`: Music tags
            - Themes (e.g., Game, Vlog), Moods (e.g., Funny), Genres (e.g., 8-bit, Electronic)
          - `artists`: List of associated artists (if any)
            - `artist_name`: Artist name
            - `uid`: Artist UID
          - `cover_color_hsv`: Dominant HSV color of the cover
          - `can_background_play`: Whether background playback is supported
      operationId: fetch_music_search_api_v1_douyin_search_fetch_music_search_post
      tags:
        - Douyin-Search-API
        - Douyin-Search-API
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MusicSearchRequest'
      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: G32FWIjObO-ve4SNPRhxm
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: G32FWIjObO-ve4SNPRhxm
            scopes:
              G32FWIjObO-ve4SNPRhxm:
                HTTPBearer: []
      x-apifox-folder: Douyin-Search-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-370212797-run
components:
  schemas:
    MusicSearchRequest:
      properties:
        keyword:
          type: string
          title: Keyword
          description: 关键词 / Keyword
          default: 猫咪
        cursor:
          type: integer
          title: Cursor
          description: >-
            偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained
            from the last response
          default: 0
        sort_type:
          type: string
          title: Sort Type
          description: >-
            排序方式：0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most
            Likes, 2=Latest
          default: '0'
        publish_time:
          type: string
          title: Publish Time
          description: >-
            发布时间筛选：0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter:
            0=Unlimited, 1=Last day, 7=Last week, 180=Last half year
          default: '0'
        filter_duration:
          type: string
          title: Filter Duration
          description: >-
            视频时长过滤：0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration
            filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes,
            5-10000=More than 5 minutes
          default: '0'
        content_type:
          type: string
          title: Content Type
          description: >-
            内容类型：0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture,
            3=Article
          default: '0'
        search_id:
          type: string
          title: Search Id
          description: >-
            搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from
            the last response
          default: ''
        backtrace:
          type: string
          title: Backtrace
          description: >-
            翻页回溯标识，用于翻页，从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from
            the last response
          default: ''
      type: object
      title: MusicSearchRequest
      x-apifox-orders:
        - keyword
        - cursor
        - sort_type
        - publish_time
        - filter_duration
        - content_type
        - search_id
        - backtrace
      x-apifox-ignore-properties: []
      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: []

```