Xiaohongshu (RedNote) PGY note metrics API
Get the figures PGY shows a brand for one Xiaohongshu note, by note ID: impressions, reads, likes, saves, comments, shares and the follows it brought, the brand it was reported for, the click-through band of the brand's components (comment area, text, bottom), and its title, text, pictures, time published and creator ID. For closing a sponsored note's campaign and checking what a creator delivered. PGY keeps figures for its creators' notes only; a note it has none for (such as a brand's own) is a 404. One object a call; $0.0400 per call. Errors and timeouts are not charged.
Try it
Change a value and the request on the right follows.Sign in to run it; it runs on your own balance. New accounts can try this endpoint free, up to 2 calls.
Used to call POST /v1/xiaohongshu/pgy/notes/detail? It is this address now. What changed for old endpoints
curl -G "https://api.dataxapi.com/v1/xiaohongshu/pgy/notes/get" \ --data-urlencode "id=6a20edfa0000000021020951" \ -H "Authorization: Bearer $DATAXAPI_API_KEY"
{
"code": "ok",
"request_id": "12cc3ae7-48f8-485e-87d9-88a012e11bed",
"data": {
"item": {
"id": "6aa68ad700000000cc4e240a",
"url": "https://www.xiaohongshu.com/explore/6aa68ad700000000cc4e240a",
"type": "image",
"title": "关于周末露营,我踩过的五个坑",
"text": "周末的周末露营日常,随手记录一下",
"published_at": "2026-11-06T08:58:31.000Z",
"images": [
"https://sns-webpic-qc.xhscdn.com/20261013/8f1dc0a9ba488c20db59!nd_dft_wlteh_webp_3",
"https://sns-webpic-qc.xhscdn.com/20261013/13bf10108e7eae003580!nd_dft_wlteh_webp_3",
// … 13 more
],
"creator_id": "6a72df4700000000f893a8a0",
"creator_name": "周末露营这件事,越简单越好",
"brand": "把周末露营从头到尾讲清楚,看完少走弯路",
"brand_id": "6659928c00000000428fe21c",
"metrics": {
"impressions": 24405,
"views": 4482,
"likes": 203,
"favorites": 171,
"comments": 46,
"shares": 36,
"follows": 22
},
"component_clicks": {
"comment_area": "normal",
"content": null,
"note_bottom": null
}
}
},
"warnings": [],
"meta": {
"capability": "xiaohongshu.pgy.notes.get",
"result_status": "complete",
"fetched_at": "2026-11-10T19:33:48.000Z",
"cached": false,
"replayed": false,
"unavailable": {},
"billing": {
"amount": "0.04",
"currency": "USD",
"balance_after": "9.96"
}
}
}From a response recorded 2026-11-10 19:33 UTC. Names, text and IDs are examples, and so are the links: none is the recorded one (the page shows no one's personal data); the figures are as recorded. Long lists are cut. The request ID, cursor and balance are made up.
Size as sent: 4.6 KB in the standard view (846 B compact, 4.6 KB full).
curl -G "https://api.dataxapi.com/v1/xiaohongshu/pgy/notes/get" \ --data-urlencode "id=6a20edfa0000000021020951" \ -H "Authorization: Bearer $DATAXAPI_API_KEY"
# pip install dataxapi from dataxapi import DataXAPI dx = DataXAPI() # reads DATAXAPI_API_KEY result = dx.xiaohongshu.pgy.notes.get(id="6a20edfa0000000021020951") print(result["data"]["item"])
// npm i @dataxapi/sdk import { DataXAPI } from "@dataxapi/sdk"; const dx = new DataXAPI(); // reads DATAXAPI_API_KEY const result = await dx.xiaohongshu.pgy.notes.get({ id: "6a20edfa0000000021020951" }); console.log(result.data.item);
dataxapi call xiaohongshu.pgy.notes.get id=6a20edfa0000000021020951
{
"mcpServers": {
"dataxapi": {
"type": "http",
"url": "https://api.dataxapi.com/mcp",
"headers": {
"Authorization": "Bearer ${DATAXAPI_API_KEY}"
}
}
}
}Add this to your MCP client, then ask your agent to call xiaohongshu.pgy.notes.get.
Parameters
Note ID, 24 hexadecimal characters: the part after explore/ in a Xiaohongshu note link, or an id the PGY creator notes endpoint returns. Example: 6a20edfa0000000021020951.
How much of each item to return. All three cost the same. Values: compact, standard (default), full.
Return only these fields. Each by its path, such as author.name.
Known limits
- One object per call: there is nothing to page.
Returned fields
data.item is one pgy note detail object. Preview: the structure may change, announced beforehand.
Note ID
Link to the note, with the access token the platform gives, so it opens as it is
An image note or a video noteimagevideo
The note's title
The note's text
Long text: the compact view keeps the first 500 characters and says so in warnings.
When it was published
Show all 26 fields →
Addresses of the pictures, in the note's order
The creator's PGY creator ID, as the other PGY creator endpoints take it
The creator's name
The brand the note was reported as sponsored by, in the platform's words; null when it is no reported sponsored note
The Xiaohongshu account ID of that brand; null when there is none
The figures PGY gives for the note
Impressions
Reads
Likes
Saves
Comments
Shares
Follows the note brought (new followers gained from it)
The click-through band of each component the brand put in the note (PGY's component clicks); null when the note has no such figures
Click-through band of the comment-area component: normal (0-2%), high (2-10%) or very_high (over 10%), as PGY grades it; null when the note carries no such componentnormalhighvery_high
Click-through band of the in-text component: normal (0-2%), high (2-10%) or very_high (over 10%), as PGY grades it; null when the note carries no such componentnormalhighvery_high
Click-through band of the component at the bottom of the note: normal (0-2%), high (2-10%) or very_high (over 10%), as PGY grades it; null when the note carries no such componentnormalhighvery_high
Which numbers of this item are approximate or lower bounds; absent when all are exact
Path of the field, such as metrics.views
Approximate, or a lower boundapproximatelower_bound
Typical size of one item: compact 523 B, standard 4.3 KB, full 4.3 KB (measured on the response recorded 2026-11-10 19:33 UTC).
When you are charged
X-Max-Price to refuse anything above your own limit)Prices as read 2026-11-21 02:40 UTC, under price book 19, in effect since 2026-11-17 18:04 UTC; the Playground reads the price in force before a run.
If the object does not exist
The answer is 404 not_found. charged and amount in the body say what this one cost. reason says which: not_found (it does not exist) or private_or_deleted.
Errors
What this endpoint can answer with; codes all endpoints share are on the full list.
invalid_paramsA parameter is invalidRetry: After a fixAs the answer's charged field saysinsufficient_balanceThe balance is too lowRetry: After a fixNonot_foundThe object does not exist, is private or was deletedRetry: NoAs the answer's charged field saysupstream_failedNo result came back this time and nothing was charged; retry shortlyRetry: YesNotimeoutThe data did not arrive in time; retry with the same idempotency keyRetry: YesNoQuestions
How much does the Xiaohongshu (RedNote) PGY note metrics API cost?
$0.0400 per call. The most one call can cost is $0.0400.
When am I not charged?
Errors and timeouts are not charged.
What happens if the object does not exist?
The answer is 404 not_found. charged and amount in the body say what this one cost. reason says which: not_found (it does not exist) or private_or_deleted.
30-day availability
100% of the time over the last 29 days (since 2026-10-22, when the record began), this endpoint was serving calls: at least one of its routes was taking them, so it was neither paused nor down.
A failed call is not charged.
Every endpoint's state now, and each incident with whether anyone was charged: the status page →
All 30 Xiaohongshu (RedNote) endpoints
Use it in your AI
Copy this prompt
Your API key is built in, so there is nothing to configure.
No account yet? Sign-up takes an email and no card, and a failed call is never charged.
Paste it into your agent
It reads the page the prompt points to and connects itself.
Now ask something
Use one of these, or your own words.
Prefer to set it up by hand?
dataxapi setupgives the agents on your machine (Claude Code, Codex, Cursor) the DataXAPI MCP server and the base skill. The key is read from DATAXAPI_API_KEY; none is written into a file.MCP server: https://api.dataxapi.com/mcp. The entry for your client is under MCP in the request examples of this page; then ask your agent to call xiaohongshu.pgy.notes.get.Other clients →Show the text
Use the DataXAPI endpoint xiaohongshu.pgy.notes.get (Xiaohongshu (RedNote) PGY note metrics). Get the figures PGY shows a brand for one Xiaohongshu note, by note ID: impressions, reads, likes, saves, comments, shares and the follows it brought, the brand it was reported for, the click-through band of the brand's components (comment area, text, bottom), and its title, text, pictures, time published and creator ID. For closing a sponsored note's campaign and checking what a creator delivered. PGY keeps figures for its creators' notes only; a note it has none for (such as a brand's own) is a 404. Call GET https://api.dataxapi.com/v1/xiaohongshu/pgy/notes/get with the header "Authorization: Bearer $DATAXAPI_API_KEY". Read the key from the environment variable DATAXAPI_API_KEY; never write it into code. Parameters: - id (required): Note ID, 24 hexadecimal characters: the part after explore/ in a Xiaohongshu note link, or an id the PGY creator notes endpoint returns. Example: 6a20edfa0000000021020951. - view: How much of each item to return. All three cost the same. Values: compact, standard (default), full. - fields: Return only these fields. Each by its path, such as author.name. Price: $0.0400 per call. Errors and timeouts are not charged. The answer is JSON: data.item holds pgy note detail; meta.billing.amount is what this call was charged. Example: curl -G "https://api.dataxapi.com/v1/xiaohongshu/pgy/notes/get" \ --data-urlencode "id=6a20edfa0000000021020951" \ -H "Authorization: Bearer $DATAXAPI_API_KEY" Full reference in Markdown: https://dataxapi.com/apis/xiaohongshu/pgy/notes/get.md
Names and identifiers
- In Chinese
- 小红书蒲公英笔记数据 API
- Endpoint ID
xiaohongshu.pgy.notes.get- Endpoint
GET /v1/xiaohongshu/pgy/notes/get
Start with one key.
237 endpoints on 21 platforms, from $0.0003 a call. Errors and timeouts are not charged.