# 搜索接口/Search API

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/lemon8/app/fetch_search:
    get:
      summary: 搜索接口/Search API
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 搜索接口

        ### 参数:

        - query: 搜索关键词

        - max_cursor:
        翻页参数，可以从上一次请求的返回结果中获取，第一次请求为空，后续请求使用上一次请求返回的`max_cursor`进行翻页，可以通过返回结果的`has_more`字段判断是否还有更多数据。

        - filter_type: 搜索过滤类型，默认为空字符串，可选值如下：
            - 空字符串：All（全部，默认使用此参数搜索）
            - video：只搜索视频作品
            - posts：只搜索文章作品
        - order_by: 搜索排序方式，默认为空字符串，可选值如下：
            - 空字符串：Relevance（相关度，默认使用此参数排序）
            - popular：流行度排序
            - recent：从新到旧排序
        - search_tab: 搜索类型，默认为`main`，可选值如下：
            - main：APP中显示为 `Top`（综合搜索，默认使用此参数搜索）
            - user：APP中显示为 `Accounts` （搜索用户账号）
            - hashtag：APP中显示为 `Hashtags`（搜索话题）
            - article：APP中显示为 `Posts`（搜索文章）
        ### 返回:

        - 搜索结果


        # [English]

        ### Purpose:

        - Search API

        ### Parameters:

        - query: Search keyword

        - max_cursor: Pagination parameter, can be obtained from the return
        result of the last request. It is empty for the first request, and the
        `max_cursor` returned by the last request is used for subsequent
        requests. You can judge whether there is more data by the `has_more`
        field in the return result.

        - filter_type: Search filter type, default is an empty string, optional
        values are as follows:
            - Empty string: All (default using this parameter to search)
            - video: Search only video
            - posts: Search only posts
        - order_by: Search sort type, default is an empty string, optional
        values are as follows:
            - Empty string: Relevance (default using this parameter to sort)
            - popular: Sort by popularity
            - recent: Sort from new to old
        - search_tab: Search type, default is `main`, optional values are as
        follows:
            - main: Display as `Top` in the APP (comprehensive search, default using this parameter to search)
            - user: Display as `Accounts` in the APP (search user accounts)
            - hashtag: Display as `Hashtags` in the APP (search hashtags)
            - article: Display as `Posts` in the APP (search articles)
        ### Return:

        - Search results


        # [示例/Example]

        query = "lemon8"

        max_cursor = ""

        filter_type = ""

        order_by = ""

        search_tab = "main"
      operationId: fetch_search_api_v1_lemon8_app_fetch_search_get
      tags:
        - Lemon8-App-API
        - Lemon8-App-API
      parameters:
        - name: query
          in: query
          description: 搜索关键词/Search keyword
          required: true
          example: lemon8
          schema:
            type: string
            description: 搜索关键词/Search keyword
            title: Query
        - name: max_cursor
          in: query
          description: 翻页参数/Pagination parameter
          required: false
          example: ''
          schema:
            type: string
            description: 翻页参数/Pagination parameter
            default: ''
            title: Max Cursor
        - name: filter_type
          in: query
          description: 搜索过滤类型/Search filter type
          required: false
          example: ''
          schema:
            type: string
            description: 搜索过滤类型/Search filter type
            default: ''
            title: Filter Type
        - name: order_by
          in: query
          description: 搜索排序方式/Search sort type
          required: false
          example: ''
          schema:
            type: string
            description: 搜索排序方式/Search sort type
            default: ''
            title: Order By
        - name: search_tab
          in: query
          description: 搜索类型/Search type
          required: false
          example: main
          schema:
            type: string
            description: 搜索类型/Search type
            default: main
            title: Search Tab
      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: ikkv1KFcfrQdvDYfy6j3d
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: ikkv1KFcfrQdvDYfy6j3d
            scopes:
              ikkv1KFcfrQdvDYfy6j3d:
                HTTPBearer: []
      x-apifox-folder: Lemon8-App-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-246049896-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: []

```