# 获取笔记评论列表/Get note comments

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/xiaohongshu/app_v2/get_note_comments:
    get:
      summary: 获取笔记评论列表/Get note comments
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取指定笔记的评论列表，支持分页和多种排序方式

        ### ⚠️ 计费提示:

        - 如果传入错误或不存在的笔记ID（或分享链接解析失败），接口仍会正常响应，但 `data` 中会返回上游"服务异常"信息，该请求
        **同样会正常计费扣费**，请在调用前确保参数有效。

        ### 参数:

        - note_id: 笔记ID，如 "697c0eee000000000a03c308"

        - share_text: 小红书分享链接，支持APP和Web端分享链接，支持 `xiaohongshu.com`
        长链接、`xhslink.com` 和 `xhslink.cn` 短链接

        - 优先使用`note_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`note_id`为准。

        - cursor: 分页游标，首次请求留空，翻页时传入上一次响应中返回的 cursor 值

        - index: 评论索引，首次请求传 0，翻页时传入上一次响应中返回的 index 值

        - pageArea: 折叠状态，默认 "UNFOLDED"（展开），翻页时传入上一次响应中返回的 pageArea 值

        - sort_strategy: 排序策略
            - "latest_v2": 按时间倒序（最新，默认使用）
            - "like_count": 按点赞数排序（最热）
            - "default": 默认排序（不推荐，翻页时会丢失评论或重复抓取评论）
        ### 返回:

        - 评论数据对象，包含评论列表、分页游标等

        ### 翻页说明:

        - 首次请求：cursor留空，index传0

        - 翻页请求：传入上一次响应中返回的 cursor 和 index 和 pageArea 值

        - 翻页所需字段通常位于响应的 `$.data.data` 对象中（如 cursor ←
        `$.data.data.cursor`），请从上一次响应中提取对应值传入


        # [English]

        ### Purpose:

        - Get comment list for a specified note, supports pagination and
        multiple sort strategies

        ### ⚠️ Billing Notice:

        - If a wrong or non-existent note ID is passed (or the share link fails
        to parse), the endpoint still responds normally, but the `data` field
        will contain an upstream "service error" message. Such requests **will
        still be billed as normal**. Please make sure the parameters are valid
        before calling.

        ### Parameters:

        - note_id: Note ID, e.g. "697c0eee000000000a03c308"

        - share_text: Xiaohongshu sharing link, supports APP and Web sharing
        links, including `xiaohongshu.com` full links, `xhslink.com` and
        `xhslink.cn` short links

        - Prefer to use `note_id`, if not, use `share_text`, one of the two
        parameters is required, if both are carried, `note_id` shall prevail.

        - cursor: Pagination cursor, leave empty for first request, pass cursor
        value from previous response for next page

        - index: Comment index, pass 0 for first request, pass index value from
        previous response for next page

        - pageArea: Fold status, default "UNFOLDED" (unfolded), pass pageArea
        value from previous response for next page

        - sort_strategy: Sort strategy
            - "latest_v2": Sort by time desc (latest, recommended default)
            - "like_count": Sort by like_count
            - "default": Sort by default (not recommended, may cause missing or duplicate comments when paginating)
        ### Return:

        - Comments data object, including comment list, pagination cursor, etc.

        ### Pagination Guide:

        - First request: leave cursor empty, pass index as 0

        - Next page: pass cursor and index and pageArea values from previous
        response

        - The pagination fields are usually located in the `$.data.data` object
        of the response (e.g. cursor ← `$.data.data.cursor`), extract the
        corresponding values from the previous response


        # [示例/Example]

        note_id="697c0eee000000000a03c308"

        sort_strategy="latest_v2"
      operationId: get_note_comments_api_v1_xiaohongshu_app_v2_get_note_comments_get
      tags:
        - Xiaohongshu-App-V2-API
        - Xiaohongshu-App-V2-API
      parameters:
        - name: note_id
          in: query
          description: 笔记ID/Note ID
          required: false
          example: 697c0eee000000000a03c308
          schema:
            type: string
            description: 笔记ID/Note ID
            default: ''
            title: Note Id
        - name: share_text
          in: query
          description: >-
            分享链接，支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports
            xiaohongshu.com, xhslink.com, xhslink.cn
          required: false
          example: http://xhslink.com/o/8GqargIxrko
          schema:
            type: string
            description: >-
              分享链接，支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports
              xiaohongshu.com, xhslink.com, xhslink.cn
            default: ''
            title: Share Text
        - name: cursor
          in: query
          description: 分页游标，首次请求留空/Pagination cursor, leave empty for first request
          required: false
          example: ''
          schema:
            type: string
            description: 分页游标，首次请求留空/Pagination cursor, leave empty for first request
            default: ''
            title: Cursor
        - name: index
          in: query
          description: 评论索引，首次请求传0/Comment index, pass 0 for first request
          required: false
          example: 0
          schema:
            type: integer
            description: 评论索引，首次请求传0/Comment index, pass 0 for first request
            default: 0
            title: Index
        - name: pageArea
          in: query
          description: '折叠状态: UNFOLDED(默认-展开), FOLDED(折叠)'
          required: false
          example: UNFOLDED
          schema:
            type: string
            description: '折叠状态: UNFOLDED(默认-展开), FOLDED(折叠)'
            default: UNFOLDED
            title: Pagearea
        - name: sort_strategy
          in: query
          description: '排序策略/Sort strategy: default, latest_v2, like_count'
          required: false
          example: latest_v2
          schema:
            type: string
            description: '排序策略/Sort strategy: default, latest_v2, like_count'
            default: latest_v2
            title: Sort Strategy
      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: lwS2GpktfEhCyQf8S1yUu
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: lwS2GpktfEhCyQf8S1yUu
            scopes:
              lwS2GpktfEhCyQf8S1yUu:
                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-420136394-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: []

```