Xiaohongshu (RedNote)CreatorsXiaohongshu PGY API
Xiaohongshu PGY creator notes API
A page of a creator’s notes as PGY shows them (笔记案例), by PGY creator ID: reads, likes, saves, shop visitors, whether it was sponsored and for which brand. Sponsored or cross-domain sponsored notes alone, image or video notes alone, newest, most read or most engaged first, by content feature or category, with reads of organic traffic alone if wanted.
GEThttps://api.okdata.online/v1/xiaohongshu/pgy/creators/notes/list
Also calledrednote sponsored notesxhs creator brand deals
- Price
- $0.04
- per call · failed calls are free
- Returns
- About 8 notes a page
- with a cursor for the next page
- If a call fails
- Not charged
- When a data source fails, the next one is tried; errors and timeouts cost nothing.
- Status
- preview
- It may still change; any change is announced beforehand.
Parameters
| Name | Type | Description |
|---|---|---|
idrequired | string | PGY creator ID (24 hex characters, the same as the Xiaohongshu user ID), from the PGY creator search. |
tab | stringallsponsoredcross_domain | Which notes: all (the default), sponsored notes alone, or cross-domain sponsored notes alone (those with shop visitors). |
type | stringimagevideo | Image notes or video notes alone; both when left out. Only with tab=all. |
sort | stringlatestmost_readmost_engaged | Order: newest first (the default), most read first or most interactions first. |
traffic | stringallorganic | Which traffic the reads count: all, promoted traffic included (the default), or organic traffic alone. Likes and saves stay the same. |
feature_tag | string | Only notes with this content feature tag, as written in the creator detail’s ext.feature_tags. A tag that does not exist finds nothing. |
category | string | Only notes of this content category, as written in the creator detail’s categories. A category that does not exist finds nothing. |
cursor | string | Opaque cursor from page.next_cursor of the previous call. Each page is a separate call. |
view | stringcompactstandardfull | How much of each object comes back. full adds platform-specific fields under ext. |
fields | string[] | Fields to keep, by path (author.name), to save tokens. In a query string: comma-separated. |
cursor, view and fields work the same on every endpoint: how requests work.
Request
cURL
curl -G "https://api.okdata.online/v1/xiaohongshu/pgy/creators/notes/list" \
-H "Authorization: Bearer $OKDATA_API_KEY" \
--data-urlencode 'id=591662306a6a6967b63e7f16'Python
import os
import requests
resp = requests.get(
"https://api.okdata.online/v1/xiaohongshu/pgy/creators/notes/list",
headers={"Authorization": f"Bearer {os.environ['OKDATA_API_KEY']}"},
params={"id": "591662306a6a6967b63e7f16"},
timeout=60,
)
body = resp.json()
if body["code"] != "ok":
raise RuntimeError(f"{body['code']}: {body['message']} (charged: {body['charged']})")
for row in body["data"]["items"]:
print(row)
print("cost: $" + body["meta"]["billing"]["amount"])TypeScript
const url = new URL('https://api.okdata.online/v1/xiaohongshu/pgy/creators/notes/list');
url.searchParams.set('id', "591662306a6a6967b63e7f16");
const res = await fetch(url, {
headers: {
Authorization: `Bearer ${process.env.OKDATA_API_KEY}`,
},
});
const body = await res.json();
if (body.code !== 'ok') throw new Error(`${body.code}: ${body.message}`);
for (const row of body.data.items) {
console.log(row);
}
console.log('cost: $' + body.meta.billing.amount);MCPtools/call
{
"name": "call",
"arguments": {
"capability": "xiaohongshu.pgy.creators.notes.list",
"id": "591662306a6a6967b63e7f16"
}
}Response
{
"code": "ok",
"request_id": "0f6c2a8e-4b1d-4e0a-9a51-3c7d2b9e1f20",
"data": {
"items": [
{
"id": null,
"title": null,
"type": null,
"published_at": null,
"cover_url": null,
"is_sponsored": null,
"brand": null,
"is_promoted": null,
"metrics": {
"views": null,
"likes": null,
"favorites": null,
"shop_visits": null
}
}
]
},
"page": {
"next_cursor": "eyJvIjoyMH0",
"has_more": true
},
"warnings": [],
"meta": {
"capability": "xiaohongshu.pgy.creators.notes.list",
"billing": {
"amount": "0.04",
"currency": "USD",
"balance_after": "9.96"
},
"unavailable": {},
"cached": false,
"replayed": false,
"fetched_at": "2026-11-11T08:00:00Z"
}
}Try it
This sends a real call to https://api.okdata.online and is billed as usual: at most $0.04. Failed calls are free. Your key goes only to that address and is never stored on this site.
Known limits
- About 8 notes come back per page; the platform sets the page size, so there is no page-size parameter.
- For the next page, pass
page.next_cursorback ascursor. A cursor stays valid for 24 hours. Whenpage.has_moreis false there is nothing left.
Returned fields
data.items is a list of PgyCreatorPost.
| Field | Type | View | Description |
|---|---|---|---|
id | string | compact | Note ID. |
title | string | null | compact | The note's title. |
type | string | null | compact | Image note or video note. |
published_at | string | null | compact | Publication day, as 00:00 China time (the platform gives the day only). |
cover_url | string | null | standard | Cover image. |
is_sponsored | boolean | null | compact | Whether it was made for a brand (see brand). |
Show all 10 fieldsHide the other 4
| Field | Type | View | Description |
|---|---|---|---|
brand | string | null | compact | The brand it was made for, in the platform's words; null when not sponsored. |
is_promoted | boolean | null | compact | Whether paid promotion sent traffic to it (含推广流量); not the same as sponsored. |
metrics | PgyPostMetrics | compact | The note's figures. |
ext | object | full | Platform-specific extras. Only returned with view=full. |
The view column is the smallest view a field comes back in: compact returns only compact fields, standard adds the standard ones, full returns everything. The default is standard.
When it is charged
One call costs $0.04 and returns one page of about 8 notes. Collecting 1,000 notes takes about 125 calls, $5.00 in total. Each page is a separate call; failed calls are not charged.
Data comes back$0.04 per call
Bad parameters, errors, timeoutsFree
| When | Charge |
|---|---|
| Each further page | A new call: $0.04 |
| Most one call costs | $0.04 |
| An empty answer | $0.04 |
| Not found (the platform has no such item) | Free |
| Bad parameters, errors, timeouts | Free |
| A retry with the same Idempotency-Key within 24 hours | Charged once |
A failed call is free; an empty answer costs $0.04; not found is free.
Prices from price book 1b273c48fea9634e. Every price on this platform →
Common errors
Every error has the same shape and says whether it was charged. The ones this endpoint can return:
| HTTP | Code | Meaning | Charged |
|---|---|---|---|
| 400 | invalid_params | A parameter is missing, has the wrong type or value, or the method is wrong. problems lists each one; param names the first.Retry: after a fix | no |
| 400 | cursor_mismatch | The cursor was sent to another endpoint, or with other parameters than the page it came from (view and fields may change).Retry: after a fix | no |
| 401 | unauthorized | The key is missing, malformed, revoked, disabled or expired (reason says which when known).Retry: no | no |
| 402 | insufficient_balance | The balance (available) cannot cover the most this call could cost (required).Retry: after a fix | no |
| 404 | not_found | The post, account or page does not exist or is not public. Endpoints whose charge_when_not_found is above 0 charge this answer (the source billed us for it): the body then says charged: true and amount.Retry: no | no |
| 410 | cursor_expired | The cursor is older than the endpoint's cursor lifetime (page.cursor_expires_at said when).Retry: no | no |
| 429 | rate_limited | The account sent too many requests this minute (reason: rate) or has too many calls running (reason: concurrency).Retry: yes | no |
| 500 | settlement_unknown | The data came back, but the charge could not be confirmed.Retry: with the same Idempotency-Key | unknown until looked up |
| 502 | upstream_failed | Every data source for this endpoint failed on this request.Retry: yes | no |
| 503 | capability_paused | This endpoint is paused right now; nothing ran.Retry: yes | no |
| 504 | timeout | The data did not come back in time. The hold was released, so nothing was charged.Retry: yes | no |
Questions
How much does the Xiaohongshu PGY creator notes API cost?
One call costs $0.04 and returns one page of about 8 notes. Collecting 1,000 notes takes about 125 calls, $5.00 in total. Each page is a separate call; failed calls are not charged.
How do I get the next page?
Pass page.next_cursor from the response back as the cursor parameter. When page.has_more is false there is nothing left. Every page is its own call at $0.04.
Do I need a Xiaohongshu (RedNote) account, cookies or a QR login?
No. You send only your okdata API key. The data is public data from Xiaohongshu (RedNote); nothing is fetched with your own Xiaohongshu (RedNote) account.
Am I charged when a call fails?
No. Every error response says charged: false, except a timeout, which says charged: null until the outcome is known. Resend with the same Idempotency-Key and you are never charged twice.
What if Xiaohongshu (RedNote) does not show a field?
The field is null, and meta.unavailable names it with the reason: platform (the platform never shows it) or capability (we cannot fetch it yet).
Use it in your AI
Paste this into Claude, ChatGPT, Cursor or any agent that can open a web page. It reads this endpoint’s page and calls it with your key.
Read https://okdata.online/apis/xiaohongshu/pgy/creators/notes/list.md, then call this endpoint for me through okdata; my key is in the OKDATA_API_KEY environment variable. Use Xiaohongshu PGY creator notes and sum up what comes back.
With the MCP server connected, just ask: Use Xiaohongshu PGY creator notes and sum up what comes back.
All 30 Xiaohongshu (RedNote) endpoints
Xiaohongshu PGY API
- Xiaohongshu PGY creator search$0.04/call
- Xiaohongshu PGY creator detail$0.04/call
- Xiaohongshu PGY keyword search index$0.04/call
- Xiaohongshu PGY related keywords$0.04/call
- Xiaohongshu PGY creator audience$0.04/call
- Xiaohongshu PGY creator note metrics$0.04/call
- Xiaohongshu PGY creator follower history$0.04/call
- Xiaohongshu PGY similar creators$0.04/call
- Xiaohongshu PGY trending notes$0.04/call
- Xiaohongshu PGY creator costs and summary$0.04/call
- Xiaohongshu PGY creator follower quality$0.04/call
- Xiaohongshu PGY creator core figures history$0.04/call
- Xiaohongshu PGY note figures$0.04/call
Main Xiaohongshu (RedNote) endpoints
- Xiaohongshu note search$0.02/call
- Xiaohongshu note detail$0.02/call
- Xiaohongshu note comments$0.02/call
- Xiaohongshu account profile$0.02/call
- Xiaohongshu account notes$0.02/call
- Xiaohongshu hot topics$0.02/call
- Xiaohongshu image search$0.02/call
- Xiaohongshu comment replies$0.02/call
- Xiaohongshu topic notes$0.02/call
- Xiaohongshu topic detail$0.02/call
- Xiaohongshu account search$0.02/call
- Xiaohongshu search suggestions$0.02/call
- Xiaohongshu video note with its video$0.02/call
Xiaohongshu (RedNote) API overview →Xiaohongshu (RedNote) API pricing →
Names and ID
- Name
- Xiaohongshu PGY creator notes API
- Short name
- Xiaohongshu PGY creator notes
- ID
xiaohongshu.pgy.creators.notes.list- Endpoint
GET /v1/xiaohongshu/pgy/creators/notes/list- Category
- Creators
- Group
- Xiaohongshu PGY API
- Also called
- rednote sponsored notes, xhs creator brand deals
- Data type
- Creator posts API
- Returns
- PgyCreatorPost[]: 10 fields