Xiaohongshu-PGY-API

获取蒲公英博主笔记案例 v2(覆盖跨域)/Get PGY blogger note cases v2 (cross-platform)

Changed on

[中文]

用途:

  • 分页获取博主的笔记案例(v2)。与 /get_blogger_notes 是两套独立接口: 覆盖范围更广(含跨平台/跨域笔记),返回结构也不同
  • 当 /get_blogger_notes 返回空列表时改用本接口
  • 两接口的 note_type 取值与返回字段都不一样,不能混用,按各自参数调用

请求体参数:

  • user_id: 必填,博主用户ID
  • page_number: 页码,从 1 开始
  • page_size: 每页数量,1-8(蒲公英网页固定 8,不能更大)
  • note_type: 笔记类型,0=全部类型(默认) 1=图文 2=视频
  • order_type: 排序,1=最新发布(默认) 2=阅读最多 3=互动最多

返回:

  • noteList[]: 笔记数组,每条含 noteInfo(noteId / title / imageUrl / notePublishTime / noteType / impNum 曝光 / readNum 阅读 / engageNum 互动 / favNum 收藏)+ userInfo(博主信息)
  • total: 符合筛选的笔记总数

翻页:

  • 只改 page_number,其余参数原样保持不变;翻到某页返回空数组即没有更多

响应结构(取数要剥两层):

  • resp["data"] 是蒲公英原样信封(含 code/msg/success),业务数据还在它里面一层
  • 正确取法:data = resp["data"]["data"];下面「返回」列的字段都在这一层下

计费:

  • HTTP 200 → 计费。包含「查无结果」(data 为 null,如 ID 不存在或筛选无命中)—— 请求已送达蒲公英,同样扣费,不要因为拿不到数据就重试
  • HTTP 400 → 不计费(参数格式非法,或上游资源不足/异常)

[English]

Purpose:

  • Paginated note cases of a blogger (v2). A separate endpoint from /get_blogger_notes: wider coverage (incl. cross-platform notes) and a different response shape
  • Use this when /get_blogger_notes returns an empty list
  • The two endpoints differ in note_type values and return fields; do not mix them

Request Body Parameters:

  • user_id: required, blogger user ID
  • page_number: page number from 1
  • page_size: 1-8 (fixed at 8 on the PGY web page, cannot be larger)
  • note_type: 0=all (default), 1=image-text, 2=video
  • order_type: 1=newest (default), 2=most read, 3=most engaged

Return:

  • noteList[]: each item has noteInfo (noteId / title / imageUrl / notePublishTime / noteType / impNum / readNum / engageNum / favNum) + userInfo
  • total: total notes matching the filters

Paging:

  • Change page_number only, keep other params identical; an empty array means no more data

Response shape (two layers):

  • resp["data"] is PGY's raw envelope (with code/msg/success); the payload is one level deeper
  • Correct access: data = resp["data"]["data"] — every field listed under "Return" lives here

Billing:

  • HTTP 200 → charged, including "no result" (data is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota
  • HTTP 400 → not charged (malformed params, or upstream unavailable/error)

[示例/Example]

// ① 第一页
{"user_id": "592b6f7c5e87e74d3669f3ba", "page_number": 1, "page_size": 8}

// ② 只看视频笔记
{"user_id": "592b6f7c5e87e74d3669f3ba", "page_number": 1, "page_size": 8, "note_type": 2}

// ③ 换排序
{"user_id": "592b6f7c5e87e74d3669f3ba", "page_number": 1, "page_size": 8, "order_type": 2}

什么时候用这个:/get_blogger_notes 对跨域博主返空时。 返回结构与那个接口不同(本接口在 noteList[].noteInfo 下),解析代码不要混用。

Use this when /get_blogger_notes returns empty for a cross-domain blogger.

post/api/v1/xiaohongshu/pgy/get_blogger_notes_v2

Request

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

Request body

user_idstring required

博主用户ID/Blogger user ID

page_numberinteger

页码,从 1 开始/Page number, from 1

page_sizeinteger

每页数量,1-8(蒲公英网页固定 8)/Page size, 1-8 (fixed at 8 on PGY web)

note_type0 | 1 | 2

笔记类型 0=全部类型(默认) 1=图文 2=视频/Note type

order_type1 | 2 | 3

排序 1=最新发布(默认) 2=阅读最多 3=互动最多/Sort

Example request

{
  "user_id": "5c668b3e0000000012021605",
  "page_number": 1,
  "page_size": 8,
  "order_type": 1
}

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