# 搜索/Search

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/twitter/web/fetch_search_timeline:
    get:
      summary: 搜索/Search
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 搜索

        ### 参数:

        - keyword: 搜索关键字

        - search_type: 搜索类型，默认为Top，其他可选值为Latest，Media，People, Lists

        - cursor: 游标，默认为None，用于翻页，后续从上一次请求的返回结果中获取

        ### 返回:

        - 搜索结果


        ### 关于搜索结果准确性的说明:

        - X 的搜索并不保证关键词或话题标签一定出现在推文正文（text 字段）中。

        - 匹配范围远大于正文，还包括：被引用的推文、外链文章的元数据、媒体内容以及账号信号。

        - 因此返回的推文完全可能是一条合法匹配，但关键词根本不在 text 字段里。

        - 如果在结果上再做一次"正文必须包含关键词"的字面子串过滤，会丢弃掉很大一部分有效结果
          （实测可达 94.6% 的丢弃率）。
        - 若发现结果看起来"不准"，请优先检查是否在调用侧做了这类字面过滤。


        # [English]

        ### Purpose:

        - Search

        ### Parameters:

        - keyword: Search keyword

        - search_type: Search type, default is Top, other optional values are
        Latest, Media, People, Lists

        - cursor: Cursor, default is None, used for paging, obtained from the
        last request

        ### Return:

        - Search results


        ### Note on search result accuracy:

        - X's search does not guarantee the keyword or hashtag appears in the
        tweet text.

        - Matching happens against more than the caption — it can include the
        quoted tweet,
          linked article metadata, media, and account signals.
        - So a returned tweet can be a legitimate match with the term absent
        from the text field entirely.

        - Requiring a literal substring match in `text` will discard a large
        share of valid results,
          which is consistent with the 94.6% drop rate observed in practice.
        - If results look inaccurate, first check whether such a literal filter
        is being applied downstream.


        # [示例/Example]

        keyword = "Elon Musk"

        search_type = "Top"

        cursor = None
      operationId: fetch_search_timeline_api_v1_twitter_web_fetch_search_timeline_get
      tags:
        - Twitter-Web-API
        - Twitter-Web-API
      parameters:
        - name: keyword
          in: query
          description: 搜索关键字/Search Keyword
          required: true
          example: Elon Musk
          schema:
            type: string
            description: 搜索关键字/Search Keyword
            title: Keyword
        - name: search_type
          in: query
          description: 搜索类型/Search Type
          required: false
          example: Top
          schema:
            type: string
            description: 搜索类型/Search Type
            default: Top
            title: Search Type
        - name: cursor
          in: query
          description: 游标/Cursor
          required: false
          schema:
            type: string
            description: 游标/Cursor
            title: Cursor
      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: Unm1jMVK08sdmX0LBu2ZV
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: Unm1jMVK08sdmX0LBu2ZV
            scopes:
              Unm1jMVK08sdmX0LBu2ZV:
                HTTPBearer: []
      x-apifox-folder: Twitter-Web-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-215701673-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: []

```