API reference · Xiaohongshu
xiaohongshu/pgy/blogger-list
Integrate this model through SandBase's unified API, with production-ready schemas and examples.
Production endpoint
Send your first request
OpenAI-compatible endpoint with unified authentication and usage tracking.
POST
https://api.sandbase.ai/v1/api/xiaohongshu/pgy/blogger-listModel ID
xiaohongshu/pgy/blogger-list01
Input Schema
16 parameters · 1 required · 15 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
brand_user_id | string | Required | Brand/advertiser user ID, PGY matches under this brand (required) |
coop | union | Optional | 合作笔记数据筛选/Sponsored note metric filters |
fans | union | Optional | 粉丝画像筛选/Fans profile filters |
goal | union | Optional | 合作目标筛选/Cooperation goal filters |
live | union | Optional | 直播数据筛选/Live metric filters |
note | union | Optional | 日常笔记数据筛选/Organic note metric filters |
sort | string | Optional | 排序方向 desc/asc · Options: desc, asc · Default: "desc" descasc |
flags | union | Optional | 开关类筛选/Boolean flag filters |
column | string | Optional | 排序字段，共 34 个，见接口说明的排序字段表/Sort column, 34 options, see endpoint docs · Options: comprehensiverank, fansCount, price, clickNum, mEngagementNum, accumCommonImpMedinNum30d, accumPicCommonImpMedinNum30d, accumVideoCommonImpMedinNum30d, pictureClickMidNum, videoClickMidNum, pictureInterMidNum, videoInterMidNum, thousandLikePercent30, pictureThousandLikePercent30, videoThousandLikePercent30, hundredLikePercent30, pictureHundredLikePercent30, videoHundredLikePercent30, videoFinishRate, accumCoopImpMedinNum30d, readMidCoop30, interMidCoop30, mCpuvNum30d, picturePrice, videoPrice, pictureReadCost, videoReadCost, inviteReply48hNumRatio, fans30GrowthRate, fansActiveIn28dLv, fansEngageNum30dLv, kliveCnt30d, avgLiveViewerNum, avgAgmv90d · Default: "comprehensiverank" comprehensiverankfansCountpriceclickNummEngagementNumaccumCommonImpMedinNum30daccumPicCommonImpMedinNum30daccumVideoCommonImpMedinNum30dpictureClickMidNumvideoClickMidNumpictureInterMidNumvideoInterMidNumthousandLikePercent30pictureThousandLikePercent30videoThousandLikePercent30hundredLikePercent30pictureHundredLikePercent30videoHundredLikePercent30videoFinishRateaccumCoopImpMedinNum30dreadMidCoop30interMidCoop30mCpuvNum30dpicturePricevideoPricepictureReadCostvideoReadCostinviteReply48hNumRatiofans30GrowthRatefansActiveIn28dLvfansEngageNum30dLvkliveCnt30davgLiveViewerNumavgAgmv90d |
blogger | union | Optional | 博主属性筛选/Blogger attribute filters |
keyword | string | Optional | 搜索词；空=只筛选不搜索/Keyword · Max length: 50 · Default: "" |
page_num | integer | Optional | Page number, start from 1 · Min: 1 · Max: 1000 |
page_size | integer | Optional | Page size (1-100) · Min: 1 · Max: 100 |
search_type | integer | Optional | 1=按笔记关键词找博主(默认) 0=按昵称搜/Search mode · Options: 0, 1 · Default: 1 01 |
similar_word | union | Optional | 配合 similar_user_id 的博主昵称，仅用于回显、不影响结果/Nickname echo for similar_user_id; does not affect results |
similar_user_id | union | Optional | 找相似博主：填一个博主的 userId，返回与他相似的博主，**并且可以叠加下面所有筛选**（这是它与 /get_blogger_similar 的关键区别）/Find similar bloggers; unlike /get_blogger_similar it can be combined with all filters below |
02
Output Schema
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the generation task |
status | string | Task status: pending, running, completed, failed, timeout |
model | string | Model used for the generation |
outputs | array | Array of output items |
outputs[].url | string | URL of the generated artifact |
outputs[].content_type | string | MIME type (e.g. image/png, video/mp4) |
error | object | null | Error details if failed, null on success |
error.type | string | Machine-readable error type code |
error.message | string | Human-readable error description |
03
Code Examples
Ready-to-run snippets
const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/api/xiaohongshu/pgy/blogger-list", {
method: "POST",
headers: {
Authorization: `Bearer ${apiKey}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"sort": "desc",
"column": "comprehensiverank",
"keyword": "咖啡",
"search_type": 1,
"similar_user_id": "5c668b3e0000000012021605",
"blogger": {
"content_tag": [
"美妆"
]
},
"brand_user_id": "59ae4dfc5e87e72475fb3bf3",
"fans": {
"count": {
"max": 500000,
"min": 10000
}
},
"page_num": 1,
"page_size": 5
}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());