Xiaohongshu-PGY-API

蒲公英关键词概览(搜索指数+博主画像)/PGY keyword overview

Changed on

[中文]

用途:

  • 给定一个关键词,返回它在小红书全站的热度概览,以及发这个词的博主长什么样
  • 对应蒲公英内容广场搜索后的「全站数据」+「合作博主画像」两张卡片

请求体参数:

  • search_word: 关键词,如 "面膜"

返回:

对象字段
searchWordDatasearchScore 搜索指数、noteNum 关联笔记数、userNum 搜索人数、readNum 阅读量;每项都有对应的 *30bm 字段,是近 30 日环比百分比
wordKolProfile合作博主画像:内容类目占比(如 护肤 93.8%)、账号人设占比(如 妈妈 25%)

配套接口:

  • 同一个关键词还可以调 /get_keyword_daily 看逐日走势、/get_keyword_related 看上下游关联词
  • 三个接口互相独立,按需调用

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

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

计费:

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

[English]

Purpose:

  • Site-wide popularity overview of a keyword, plus the profile of bloggers posting about it
  • Corresponds to the "Site Data" + "Blogger Profile" cards in the PGY content square

Request Body Parameters:

  • search_word: keyword, e.g. "面膜"

Return:

ObjectFields
searchWordDatasearchScore, noteNum, userNum, readNum; each has a *30bm counterpart = 30-day change in percent
wordKolProfileBlogger profile: content category share, persona share

Related:

  • /get_keyword_daily for the daily trend, /get_keyword_related for up/downstream keywords
  • The three endpoints are independent; call whichever you need

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]

{"search_word": "面膜"}

选题流程:/get_keyword_related 扩出一批词 → 逐个调本接口比 searchScore 与 noteNum → 挑「搜索量不低但笔记数少」的词,即竞争小的机会词。

同一个关键词还可以调 /get_keyword_daily 看逐日走势。三个接口互相独立,按需调用。

Workflow: expand words via /get_keyword_related, compare searchScore vs noteNum here, pick high-search / low-supply keywords.

post/api/v1/xiaohongshu/pgy/get_keyword_stat

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

search_wordstring required

关键词,如 面膜/Keyword

Example request

{
  "search_word": "面膜"
}

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