Xiaohongshu-App-V2-API

获取用户收藏笔记列表/Get user faved notes

Changed on

[中文]

用途:

  • 获取指定用户公开收藏的笔记列表,使用游标分页

⚠️ 计费提示:

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

参数:

  • user_id: 用户ID,如 "5a8cf39111be10466d285d6b"
  • share_text: 小红书分享链接,支持APP和Web端分享链接,支持 xiaohongshu.com 长链接、xhslink.com 和 xhslink.cn 短链接
  • 优先使用user_id,如果没有则使用share_text,两个参数二选一,如都携带则以user_id为准。
  • cursor: 分页游标,首次请求留空,翻页时传入上一页列表中最后一条笔记的 note_id

返回:

  • 用户收藏笔记列表数据,包含笔记基本信息和分页信息

翻页说明:

  • 首次请求:cursor留空
  • 翻页请求:传入上一页列表中最后一条笔记的 note_id

[English]

Purpose:

  • Get list of notes faved by a specified user, using cursor pagination

⚠️ Billing Notice:

  • If a wrong or non-existent user 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:

  • user_id: User ID, e.g. "5a8cf39111be10466d285d6b"
  • 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 user_id, if not, use share_text, one of the two parameters is required, if both are carried, user_id shall prevail.
  • cursor: Pagination cursor, leave empty for first request, pass last note_id from previous page for next page

Return:

  • User faved notes list data, including basic note info and pagination info

Pagination Guide:

  • First request: leave cursor empty
  • Next page: pass last note_id from previous page

[示例/Example]

user_id="5a8cf39111be10466d285d6b"

get/api/v1/xiaohongshu/app_v2/get_user_faved_notes

Request

  • Base URL
    https://api.tikhub.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

user_idstring

用户ID/User ID

share_textstring

分享链接,支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn

cursorstring

分页游标,首次请求留空,翻页时传入上一页最后一条笔记的note_id/Pagination cursor, leave empty for first request, pass last note_id from previous page for next page

Response

Successful Response

codeinteger

HTTP status code | HTTP状态码

request_idstring nullable

Unique request identifier | 唯一请求标识符

messagestring

Response message (EN-US) | 响应消息 (English)

message_zhstring

Response message (ZH-CN) | 响应消息 (中文)

supportstring

Support message | 支持消息

timestring

The time the response was generated | 生成响应的时间

time_stampinteger

The timestamp the response was generated | 生成响应的时间戳

time_zonestring

The timezone of the response time | 响应时间的时区

docsstring nullable

Link to the API Swagger documentation for this endpoint | 此端点的 API Swagger 文档链接

cache_messagestring nullable

Cache message (EN-US) | 缓存消息 (English)

cache_message_zhstring nullable

Cache message (ZH-CN) | 缓存消息 (中文)

cache_urlstring nullable

The URL to access the cached result | 访问缓存结果的 URL

routerstring

The endpoint that generated this response | 生成此响应的端点

paramsunknown
dataunknown

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response's property default value changed from This request will be cached. You can access the cached result directly using the URL below valid for 24 hours. Accessing the cache will not incur additional charges. to 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. for the status

    • info

      the response's property default value changed from 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 to 本次响应已缓存,可通过下方 URL 直接查看,有效期 24 小时,访问缓存链接无额外费用。缓存仅用于请求溯源,不影响接口数据的时效性,也不会再次通过接口返回。 for the status