For AI

Xiaohongshu (RedNote)CreatorsXiaohongshu PGY API

Xiaohongshu PGY note figures API

The figures PGY shows a brand for one 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, and its title, text, pictures, time published and creator. PGY has figures for its creators’ notes only; a note without them is not found.

GEThttps://api.okdata.online/v1/xiaohongshu/pgy/notes/get

Also calledrednote sponsored note reportxhs note impressions

Price
$0.04
per call · failed calls are free
Returns
One PgyNote
as data.item
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

NameTypeDescription
idrequiredstringNote ID (24 hex characters): the part after explore/ in a note link, or an id from the PGY creator notes. e.g. 6ad04eaa000000000b0065ba
viewstringcompactstandardfullHow much of each object comes back. full adds platform-specific fields under ext. default standard
fieldsstring[]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/notes/get" \
  -H "Authorization: Bearer $OKDATA_API_KEY" \
  --data-urlencode 'id=6ad04eaa000000000b0065ba'

Python

import os
import requests

resp = requests.get(
    "https://api.okdata.online/v1/xiaohongshu/pgy/notes/get",
    headers={"Authorization": f"Bearer {os.environ['OKDATA_API_KEY']}"},
    params={"id": "6ad04eaa000000000b0065ba"},
    timeout=60,
)
body = resp.json()
if body["code"] != "ok":
    raise RuntimeError(f"{body['code']}: {body['message']} (charged: {body['charged']})")

row = body["data"]["item"]
print(row)
print("cost: $" + body["meta"]["billing"]["amount"])

TypeScript

const url = new URL('https://api.okdata.online/v1/xiaohongshu/pgy/notes/get');
url.searchParams.set('id', "6ad04eaa000000000b0065ba");

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}`);

const row = body.data.item;
console.log(row);
console.log('cost: $' + body.meta.billing.amount);

MCPtools/call

{
  "name": "call",
  "arguments": {
    "capability": "xiaohongshu.pgy.notes.get",
    "id": "6ad04eaa000000000b0065ba"
  }
}

Response

200 · application/jsonmeta.billing.amount = 0.04
{
  "code": "ok",
  "request_id": "0f6c2a8e-4b1d-4e0a-9a51-3c7d2b9e1f20",
  "data": {
    "item": {
      "id": null,
      "url": null,
      "type": null,
      "title": null,
      "text": null,
      "published_at": null,
      "images": null,
      "creator_id": null,
      "creator_name": null,
      "brand": null,
      "brand_id": null,
      "metrics": {
        "impressions": null,
        "views": null,
        "likes": null,
        "favorites": null,
        "comments": null,
        "shares": null,
        "follows": null
      },
      "component_clicks": {
        "comment_area": null,
        "content": null,
        "note_bottom": null
      }
    }
  },
  "warnings": [],
  "meta": {
    "capability": "xiaohongshu.pgy.notes.get",
    "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.

Returned fields

data.item is one PgyNote.

FieldTypeViewDescription
idstringcompactNote ID.
urlstring | nullcompactLink to the note, with the access token that makes it open.
typestring | nullcompactImage note or video note.
titlestring | nullcompactThe note's title.
textstring | nullstandardThe note's text.Long text: view=compact may shorten it.
published_atstring | nullcompactWhen it was published.
Show all 14 fieldsHide the other 8
FieldTypeViewDescription
imagesstring[] | nullstandardPicture links in order.
creator_idstring | nullcompactThe creator's PGY ID.
creator_namestring | nullcompactThe creator's name.
brandstring | nullcompactThe sponsoring brand, in the platform's words; null when it is not a reported sponsored note.
brand_idstring | nullstandardThat brand's Xiaohongshu account ID; null when none.
metricsPgyNoteMetricscompactThe note's figures on PGY.
component_clicksPgyComponentClicks | nullstandardClick-through bands of the components the brand added; null when there are none.
extobjectfullPlatform-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 pgy_note. 1,000 lookups cost $40.00. Failed calls are not charged.

Data comes back$0.04 per call

Bad parameters, errors, timeoutsFree

WhenCharge
Most one call costs$0.04
An empty answerFree
Not found (the platform has no such item)Free
Bad parameters, errors, timeoutsFree
A retry with the same Idempotency-Key within 24 hoursCharged once

A failed call is free; an empty answer is free; 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:

HTTPCodeMeaningCharged
400invalid_paramsA 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 fixno
401unauthorizedThe key is missing, malformed, revoked, disabled or expired (reason says which when known).Retry: nono
402insufficient_balanceThe balance (available) cannot cover the most this call could cost (required).Retry: after a fixno
404not_foundThe 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: nono
429rate_limitedThe account sent too many requests this minute (reason: rate) or has too many calls running (reason: concurrency).Retry: yesno
500settlement_unknownThe data came back, but the charge could not be confirmed.Retry: with the same Idempotency-Keyunknown until looked up
502upstream_failedEvery data source for this endpoint failed on this request.Retry: yesno
503capability_pausedThis endpoint is paused right now; nothing ran.Retry: yesno
504timeoutThe data did not come back in time. The hold was released, so nothing was charged.Retry: yesno

All error codes →

Questions

How much does the Xiaohongshu PGY note figures API cost?

One call costs $0.04 and returns one pgy_note. 1,000 lookups cost $40.00. Failed calls are not charged.

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/notes/get.md, then call this endpoint for me through okdata; my key is in the OKDATA_API_KEY environment variable. Use Xiaohongshu PGY note figures and sum up what comes back.

With the MCP server connected, just ask: Use Xiaohongshu PGY note figures and sum up what comes back.

Same data on other platforms

The same kind of data from other platforms, in the same PgyNote shape:

Compare them all: Post detail API →

All 30 Xiaohongshu (RedNote) endpoints

Xiaohongshu (RedNote) API overview →Xiaohongshu (RedNote) API pricing →

Names and ID

Name
Xiaohongshu PGY note figures API
Short name
Xiaohongshu PGY note figures
ID
xiaohongshu.pgy.notes.get
Endpoint
GET /v1/xiaohongshu/pgy/notes/get
Category
Creators
Also called
rednote sponsored note report, xhs note impressions
Returns
PgyNote: 14 fields

Connect once, then just ask.

Every new key comes with $0.10 to try it. One sentence connects your agent.

Start free
Connect your AI

Paste this into your agent

Read https://okdata.online/agents.md and set up okdata for me; my key is in the OKDATA_API_KEY environment variable.

Claude Code, Cursor, Codex and other agents that can open a link set themselves up from it.

MCP serverhttps://api.okdata.online/mcp