Xiaohongshu-PGY-API

获取蒲公英博主粉丝概览/Get PGY blogger fans summary

Changed on

[中文]

用途:

  • 获取博主粉丝的核心指标概览,对应博主主页「粉丝分析 → 核心指标」

请求体参数:

  • user_id: 博主用户ID,如 "5c668b3e0000000012021605"

返回:

  • fansNum(粉丝数) / fansIncreaseNum(增量) / fansGrowthRate(增长率)
  • activeFansRate(活跃粉丝占比) / 阅读粉丝占比 / 互动粉丝占比
  • 各项的同行百分位(如 activeFansBeyondRate)

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

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

计费:

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

[English]

Purpose:

  • Core fans metrics of a blogger ("Fans Analysis → Core Metrics")

Request Body Parameters:

  • user_id: Blogger user ID

Return:

  • fansNum / fansIncreaseNum / fansGrowthRate
  • activeFansRate / reading fans ratio / engaging fans ratio
  • Percentile vs peers (e.g. activeFansBeyondRate)

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": "5c668b3e0000000012021605"}

配合 /get_blogger_fans_profile(画像)与 /get_blogger_fans_history(趋势)一起看, 三个接口分别回答「粉丝有多少」「粉丝是谁」「粉丝怎么变的」。

Use together with /get_blogger_fans_profile and /get_blogger_fans_history.

post/api/v1/xiaohongshu/pgy/get_blogger_fans_summary

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

Example request

{
  "user_id": "5c668b3e0000000012021605"
}

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