Xiaohongshu (RedNote)Creators Xiaohongshu PGY API

Xiaohongshu PGY creator note metrics API

How a creator’s everyday or sponsored notes did over the last 30 or 90 days, by PGY creator ID: notes and video notes, median impressions, reads, interactions and follows, engagement and completion rates, the share of notes past 100 and 1,000 likes, the standing among comparable creators, and where impressions and reads came from. The full view adds each note’s figures and long-term reads of notes from about half a year back.

GEThttps://api.okdata.online/v1/xiaohongshu/pgy/creators/metrics

Also calledrednote creator performancexhs creator median reads

Price: $0.04; per call · failed calls are free
Returns: One PgyCreatorMetrics; 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

Name	Type	Description
`id`required	string	PGY creator ID (24 hex characters, the same as the Xiaohongshu user ID), from the PGY creator search. e.g. `591662306a6a6967b63e7f16`
`window`	string30d90d	The period: the last 30 or 90 days. default `30d`
`tab`	stringeverydaysponsored	Whose figures: the creator’s everyday notes (the default) or sponsored notes, as the two tabs of the PGY creator page. default `everyday`
`view`	stringcompactstandardfull	How much of each object comes back. full adds platform-specific fields under ext. default `standard`
`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/metrics" \
  -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/metrics",
    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']})")

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

TypeScript

const url = new URL('https://api.okdata.online/v1/xiaohongshu/pgy/creators/metrics');
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}`);

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

MCPtools/call

{
  "name": "call",
  "arguments": {
    "capability": "xiaohongshu.pgy.creators.metrics",
    "id": "591662306a6a6967b63e7f16"
  }
}

Response

200 · application/jsonmeta.billing.amount = 0.04

{
  "code": "ok",
  "request_id": "0f6c2a8e-4b1d-4e0a-9a51-3c7d2b9e1f20",
  "data": {
    "item": {
      "creator_id": null,
      "notes": null,
      "median_impressions": null,
      "median_reads": null,
      "median_engagements": null,
      "median_likes": null,
      "median_favorites": null,
      "median_comments": null,
      "median_shares": null,
      "engagement_rate": null,
      "video_completion_rate": null,
      "image_3s_read_rate": null,
      "hundred_like_share": null,
      "thousand_like_share": null,
      "impressions_percentile": null,
      "reads_percentile": null,
      "engagements_percentile": null,
      "video_notes": null,
      "video_completion_percentile": null,
      "median_follows": null,
      "traffic_sources": {
        "impressions": {
          "homefeed": null,
          "search": null,
          "follow": null,
          "detail": null,
          "nearby": null,
          "other": null
        },
        "reads": {
          "homefeed": null,
          "search": null,
          "follow": null,
          "detail": null,
          "nearby": null,
          "other": null
        }
      },
      "long_term": {
        "published_from": null,
        "published_to": null,
        "notes": null,
        "recent_reads": null,
        "recent_reads_percentile": null,
        "long_term_reads": null,
        "long_term_reads_percentile": null,
        "recent_sources": {
          "homefeed": null,
          "search": null,
          "profile": null,
          "follow": null,
          "other": null
        },
        "long_term_sources": {
          "homefeed": null,
          "search": null,
          "profile": null,
          "follow": null,
          "other": null
        }
      },
      "note_list": [
        {
          "id": null,
          "title": null,
          "type": null,
          "published_at": null,
          "cover_url": null,
          "impressions": null,
          "reads": null,
          "engagements": null,
          "likes": null,
          "favorites": null,
          "impressions_vs_median": null,
          "reads_vs_median": null,
          "engagements_vs_median": null,
          "likes_vs_median": null,
          "favorites_vs_median": null
        }
      ]
    }
  },
  "warnings": [],
  "meta": {
    "capability": "xiaohongshu.pgy.creators.metrics",
    "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 PgyCreatorMetrics.

Field	Type	View	Description
`creator_id`	string	compact	PGY creator ID.
`notes`	integer \| null	compact	Notes in the period.
`median_impressions`	integer \| null	compact	Median impressions of a note.
`median_reads`	integer \| null	compact	Median reads of a note.
`median_engagements`	integer \| null	compact	Median interactions of a note.
`median_likes`	integer \| null	standard	Median likes of a note.

Show all 24 fieldsHide the other 18

Field	Type	View	Description
`median_favorites`	integer \| null	standard	Median saves of a note.
`median_comments`	integer \| null	standard	Median comments of a note.
`median_shares`	integer \| null	standard	Median shares of a note.
`engagement_rate`	number \| null	compact	Interactions per read, 0 to 1.
`video_completion_rate`	number \| null	standard	Completion rate of video notes, 0 to 1.
`image_3s_read_rate`	number \| null	standard	Share of image-note reads that lasted 3 seconds, 0 to 1.
`hundred_like_share`	number \| null	standard	Share of notes with 100 likes or more, 0 to 1.
`thousand_like_share`	number \| null	standard	Share of notes with 1,000 likes or more, 0 to 1.
`impressions_percentile`	number \| null	standard	Share of comparable creators this one beats on median impressions, 0 to 1.
`reads_percentile`	number \| null	standard	Share of comparable creators this one beats on median reads, 0 to 1.
`engagements_percentile`	number \| null	standard	Share of comparable creators this one beats on median interactions, 0 to 1.
`video_notes`	integer \| null	standard	Video notes in the period (included in notes).
`video_completion_percentile`	number \| null	standard	Share of comparable creators this one beats on video completion rate, 0 to 1.
`median_follows`	integer \| null	standard	Median new followers a note brought.
`traffic_sources`	PgyTrafficSources \| null	standard	Where the notes got their impressions and reads; each set adds up to 1.
`long_term`	PgyLongTerm \| null	full	Long-term performance of notes from about half a year back: recent and long-term reads, standing and sources.
`note_list`	PgyNoteFigures[] \| null	full	The period's notes one by one, oldest first, 15 at most; null when there is none.
`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 pgy_creator_metrics. 1,000 lookups cost $40.00. Failed calls are not charged.

Data comes back$0.04 per call

Bad parameters, errors, timeoutsFree

When	Charge
Most one call costs	$0.04
An empty answer	Free
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 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:

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
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
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

All error codes →

Questions

How much does the Xiaohongshu PGY creator note metrics API cost?

One call costs $0.04 and returns one pgy_creator_metrics. 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/creators/metrics.md, then call this endpoint for me through okdata; my key is in the OKDATA_API_KEY environment variable. Use Xiaohongshu PGY creator note metrics and sum up what comes back.

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

Connect your agent → MCP →

All 30 Xiaohongshu (RedNote) endpoints

Xiaohongshu PGY API

Main Xiaohongshu (RedNote) endpoints

Xiaohongshu Shop API

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

Names and ID

Name: Xiaohongshu PGY creator note metrics API
Short name: Xiaohongshu PGY creator note metrics
ID: xiaohongshu.pgy.creators.metrics
Endpoint: GET /v1/xiaohongshu/pgy/creators/metrics
Category: Creators
Group: Xiaohongshu PGY API
Also called: rednote creator performance, xhs creator median reads
Data type: Creator performance API
Returns: PgyCreatorMetrics: 24 fields