# 搜索笔记/Search notes

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/xiaohongshu/app_v2/search_notes:
    get:
      summary: 搜索笔记/Search notes
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 根据关键词搜索小红书笔记，支持多种排序方式、笔记类型筛选和发布时间筛选

        ### 参数:

        - keyword: 搜索关键词（必需），如 "美食推荐"

        - page: 页码，从 1 开始

        - sort_type: 排序方式
            - "general": 综合排序（默认）
            - "time_descending": 按时间倒序（最新）
            - "popularity_descending": 按点赞数排序（最多点赞）
            - "comment_descending": 按评论数排序（最多评论）
            - "collect_descending": 按收藏数排序（最多收藏）
            - "english_preferred": 英文优先
        - note_type: 笔记类型筛选
            - "不限": 所有类型（默认）
            - "视频笔记": 仅视频
            - "普通笔记": 仅图文
            - "直播笔记": 仅直播
        - time_filter: 发布时间筛选
            - "不限": 所有时间（默认）
            - "一天内": 24小时内
            - "一周内": 7天内
            - "半年内": 6个月内
        - search_id: 搜索ID，翻页时传入首次搜索返回的值

        - search_session_id: 搜索会话ID，翻页时传入首次搜索返回的值

        - source: 来源，默认 "explore_feed"

        - ai_mode: AI模式，0=关闭, 1=开启

        ### 返回:

        - 搜索结果数据，包含笔记列表和分页信息

        ### 翻页说明:

        - 首次请求：只传keyword和page

        - 翻页请求：传入首次搜索返回的 search_id 和 search_session_id


        # [English]

        ### Purpose:

        - Search Xiaohongshu notes by keyword, supports multiple sort types,
        note type filters, and time filters

        ### Parameters:

        - keyword: Search keyword (required), e.g. "美食推荐"

        - page: Page number, start from 1

        - sort_type: Sort type
            - "general": General sort (default)
            - "time_descending": Sort by time descending (latest)
            - "popularity_descending": Sort by like count (most liked)
            - "comment_descending": Sort by comment count (most commented)
            - "collect_descending": Sort by collect count (most collected)
            - "english_preferred": English preferred
        - note_type: Note type filter
            - "不限": All types (default)
            - "视频笔记": Video notes only
            - "普通笔记": Image notes only
            - "直播笔记": Live notes only
        - time_filter: Time filter
            - "不限": All time (default)
            - "一天内": Within 24 hours
            - "一周内": Within 7 days
            - "半年内": Within 6 months
        - search_id: Search ID, pass value from first search response for
        pagination

        - search_session_id: Search session ID, pass value from first search
        response for pagination

        - source: Source, default "explore_feed"

        - ai_mode: AI mode, 0=off, 1=on

        ### Return:

        - Search result data, including note list and pagination info

        ### Pagination Guide:

        - First request: only pass keyword and page

        - Next page: pass search_id and search_session_id from first search
        response


        # [示例/Example]

        keyword="美食推荐"

        page=1

        sort_type="general"
      operationId: search_notes_api_v1_xiaohongshu_app_v2_search_notes_get
      tags:
        - Xiaohongshu-App-V2-API
        - Xiaohongshu-App-V2-API
      parameters:
        - name: keyword
          in: query
          description: 搜索关键词/Search keyword
          required: true
          example: 美食推荐
          schema:
            type: string
            description: 搜索关键词/Search keyword
            title: Keyword
        - name: page
          in: query
          description: 页码，从1开始/Page number, start from 1
          required: false
          example: 1
          schema:
            type: integer
            description: 页码，从1开始/Page number, start from 1
            default: 1
            title: Page
        - name: sort_type
          in: query
          description: 排序方式/Sort type
          required: false
          example: general
          schema:
            type: string
            description: 排序方式/Sort type
            default: general
            title: Sort Type
        - name: note_type
          in: query
          description: '笔记类型/Note type: 不限, 视频笔记, 普通笔记, 直播笔记'
          required: false
          example: 不限
          schema:
            type: string
            description: '笔记类型/Note type: 不限, 视频笔记, 普通笔记, 直播笔记'
            default: 不限
            title: Note Type
        - name: time_filter
          in: query
          description: '发布时间筛选/Time filter: 不限, 一天内, 一周内, 半年内'
          required: false
          example: 不限
          schema:
            type: string
            description: '发布时间筛选/Time filter: 不限, 一天内, 一周内, 半年内'
            default: 不限
            title: Time Filter
        - name: search_id
          in: query
          description: 搜索ID，翻页时传入首次搜索返回的值/Search ID for pagination
          required: false
          example: ''
          schema:
            type: string
            description: 搜索ID，翻页时传入首次搜索返回的值/Search ID for pagination
            default: ''
            title: Search Id
        - name: search_session_id
          in: query
          description: 搜索会话ID，翻页时传入首次搜索返回的值/Search session ID for pagination
          required: false
          example: ''
          schema:
            type: string
            description: 搜索会话ID，翻页时传入首次搜索返回的值/Search session ID for pagination
            default: ''
            title: Search Session Id
        - name: source
          in: query
          description: 来源/Source
          required: false
          example: explore_feed
          schema:
            type: string
            description: 来源/Source
            default: explore_feed
            title: Source
        - name: ai_mode
          in: query
          description: 'AI模式：0=关闭, 1=开启/AI mode: 0=off, 1=on'
          required: false
          example: 0
          schema:
            type: integer
            description: 'AI模式：0=关闭, 1=开启/AI mode: 0=off, 1=on'
            default: 0
            title: Ai Mode
      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: qV5eUtUU3n-pEkEyVdIER
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: qV5eUtUU3n-pEkEyVdIER
            scopes:
              qV5eUtUU3n-pEkEyVdIER:
                HTTPBearer: []
      x-apifox-folder: Xiaohongshu-App-V2-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-420136398-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: []

```