# 获取用户搜索/Fetch user search

## OpenAPI Specification

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

        ### 用途:

        - 获取抖音 App 中根据关键词搜索到的用户列表。

        - 支持通过粉丝数量、用户类型进行筛选查询。


        ### 备注:

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

        - 返回的数据仅包含「用户信息」，不包括视频、话题、音乐等内容。


        ### 参数:

        - keyword: 搜索关键词，如 "人工智能"

        - cursor: 翻页游标（首次请求传0）

        - douyin_user_fans: 粉丝数量筛选
          - 为空: 不限
          - "0_1k": 1000以下
          - "1k_1w": 1000到1万
          - "1w_10w": 1万到10万
          - "10w_100w": 10万到100万
          - "100w_": 100万以上
        - douyin_user_type: 用户类型筛选
          - 为空: 不限
          - "common_user": 普通用户
          - "enterprise_user": 企业认证用户
          - "personal_user": 个人认证用户
        - search_id: 搜索ID（翻页使用）


        ### 请求体示例：

        ```json

        payload = {
            "keyword": "人工智能",
            "cursor": 0,
            "douyin_user_fans": "",
            "douyin_user_type": "",
            "search_id": ""
        }

        ```


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

        - `cursor`: 下一页游标

        - `has_more`: 是否还有更多数据（1=有，0=无）

        - `user_list[]`: 用户列表
          - `user_info`:
            - `uid`: 用户ID
            - `nickname`: 用户昵称
            - `gender`: 性别（0=未知，1=男，2=女）
            - `unique_id`: 抖音号
            - `sec_uid`: 安全UID
            - `signature`: 个性签名
            - `follower_count`: 粉丝数量
            - `avatar_thumb.url_list`: 小头像地址
            - `avatar_medium.url_list`: 中头像地址
            - `avatar_larger.url_list`: 大头像地址
            - `follow_status`: 是否已关注
            - `live_status`: 是否正在直播（0=否，1=是）
            - `enterprise_verify_reason`: 企业认证信息（若有）
            - `versatile_display`: 抖音号展示文案（例如"抖音号：xxx"）
        - `extra`:
          - `now`: 当前服务器时间戳
          - `logid`: 请求日志ID
          - `search_request_id`: 搜索请求ID

        # [English]

        ### Purpose:

        - Fetch a list of users from Douyin App based on search keywords.

        - Supports filtering by fan count and user type.


        ### Notes:

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

        - Only user information is returned. No videos, music, or hashtags.


        ### Parameters:

        - keyword: Search keyword, e.g., "AI"

        - cursor: Pagination cursor (0 for first page)

        - douyin_user_fans: Fan count filter
          - Empty: No limit
          - "0_1k": Below 1000 fans
          - "1k_1w": 1,000 to 10,000 fans
          - "1w_10w": 10,000 to 100,000 fans
          - "10w_100w": 100,000 to 1,000,000 fans
          - "100w_": Above 1,000,000 fans
        - douyin_user_type: User type filter
          - Empty: No limit
          - "common_user": Regular user
          - "enterprise_user": Enterprise-verified user
          - "personal_user": Personal-verified user
        - search_id: Search session ID for pagination


        ### Request Body Example:

        ```json

        payload = {
            "keyword": "AI",
            "cursor": 0,
            "douyin_user_fans": "",
            "douyin_user_type": "",
            "search_id": ""
        }

        ```


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

        - `cursor`: Cursor for next page

        - `has_more`: Whether more data is available (1=Yes, 0=No)

        - `user_list[]`: List of users
          - `user_info`:
            - `uid`: User ID
            - `nickname`: Nickname
            - `gender`: Gender (0=Unknown, 1=Male, 2=Female)
            - `unique_id`: Douyin ID
            - `sec_uid`: Secured UID
            - `signature`: Personal bio
            - `follower_count`: Number of followers
            - `avatar_thumb.url_list`: List of thumbnail avatar URLs
            - `avatar_medium.url_list`: List of medium avatar URLs
            - `avatar_larger.url_list`: List of large avatar URLs
            - `follow_status`: Whether followed
            - `live_status`: Whether live
            - `enterprise_verify_reason`: Enterprise verification info (if any)
            - `versatile_display`: Display text (e.g., "Douyin ID: xxx")
        - `extra`:
          - `now`: Current server timestamp
          - `logid`: Request log ID
          - `search_request_id`: Search request ID
      operationId: fetch_user_search_api_v1_douyin_search_fetch_user_search_post
      tags:
        - Douyin-Search-API
        - Douyin-Search-API
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/app__api__v1__endpoints__douyin_search__UserSearchRequest
      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: GXLv7aMG-FD3llO1AkMgQ
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: GXLv7aMG-FD3llO1AkMgQ
            scopes:
              GXLv7aMG-FD3llO1AkMgQ:
                HTTPBearer: []
      x-apifox-folder: Douyin-Search-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-370212784-run
components:
  schemas:
    app__api__v1__endpoints__douyin_search__UserSearchRequest:
      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
        douyin_user_fans:
          type: string
          title: Douyin User Fans
          description: >-
            粉丝数过滤：空=不限 0_1k=1千以下 1k_5k=1千到5千 5k_10k=5千到1万 10k_100k=1万到10万
            100k_1M=10万到100万 1M_=100万以上 / Fans filter: empty=No limit,
            0_1k=Under 1k, etc.
          default: ''
        douyin_user_type:
          type: string
          title: Douyin User Type
          description: >-
            用户类型过滤：空=不限 300=创作者 900=小店 700=音乐人 800=明星 / User type filter:
            empty=No limit, 300=Creator, 900=Shop, 700=Musician, 800=Celebrity
          default: ''
        search_id:
          type: string
          title: Search Id
          description: >-
            搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from
            the last response
          default: ''
      type: object
      title: UserSearchRequest
      x-apifox-orders:
        - keyword
        - cursor
        - douyin_user_fans
        - douyin_user_type
        - search_id
      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: []

```