xiaohongshu.pgy.bloggers.notes@v1
PGY Blogger NoteList
Page through a creator's note cases, engagement metrics, and collaboration flags.
/v1/xiaohongshu/pgy/bloggers/notesChinese name: 小红书蒲公英博主笔记 · 蒲公英博主笔记 · 列表
分页读取博主笔记案例、互动指标与合作标记。
Fielduser_idTypestringConstraints and defaultspattern: "^[a-f0-9]{24}$"RequirementRequiredFieldpage_numberTypeintegerConstraints and defaultsdefault: 1 · minimum: 1 · maximum: 1000RequirementOptionalFieldpage_sizeTypeintegerConstraints and defaultsdefault: 8 · minimum: 1 · maximum: 8RequirementOptionalFieldnote_typeTypestringConstraints and defaultsenum: "all" | "image" | "video" | "commercial" · default: "all"RequirementOptionalFieldorder_byTypestringConstraints and defaultsenum: "latest" | "reads" | "engagement" · default: "latest"RequirementOptionalFieldtrafficTypestringConstraints and defaultsenum: "all" | "organic" · default: "all"RequirementOptionalFieldfeature_tagTypestringConstraints and defaultsdefault: "" · maxLength: 64RequirementOptionalFieldcontent_tagTypestringConstraints and defaultsdefault: "" · maxLength: 64RequirementOptionalFieldthird_party_onlyTypebooleanConstraints and defaultsdefault: falseRequirementOptional{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"user_id": {
"type": "string",
"pattern": "^[a-f0-9]{24}$"
},
"page_number": {
"default": 1,
"type": "integer",
"minimum": 1,
"maximum": 1000
},
"page_size": {
"default": 8,
"type": "integer",
"minimum": 1,
"maximum": 8
},
"note_type": {
"default": "all",
"type": "string",
"enum": [
"all",
"image",
"video",
"commercial"
]
},
"order_by": {
"default": "latest",
"type": "string",
"enum": [
"latest",
"reads",
"engagement"
]
},
"traffic": {
"default": "all",
"type": "string",
"enum": [
"all",
"organic"
]
},
"feature_tag": {
"default": "",
"type": "string",
"maxLength": 64
},
"content_tag": {
"default": "",
"type": "string",
"maxLength": 64
},
"third_party_only": {
"default": false,
"type": "boolean"
}
},
"required": [
"user_id"
],
"additionalProperties": false
}{
"code": 200,
"request_id": "req_example_pgy_blogger_notes",
"message": "success",
"data": {
"creator_id": "5c668b3e0000000012021605",
"items": [
{
"id": "6a20edfa0000000021020951",
"title": "Fixture campaign note",
"cover_url": "https://ci.xiaohongshu.com/cover-fixture",
"published_at": "2026-08-01",
"note_type": "image",
"reads": 1121,
"likes": 118,
"collects": 20,
"offsite_readers": 9,
"commercial": true,
"brand_name": "Fixture brand"
}
]
},
"page": {
"page_number": 1,
"page_size": 8,
"total": 9,
"has_more": true,
"next_page": 2
},
"warnings": [],
"meta": {
"result_status": "complete",
"balance_after": "49.61",
"listing_id": "xiaohongshu.pgy.bloggers.notes",
"version": "v1",
"catalog_release_id": "catalog-production-2026-09-17.1",
"price_book_version": "pricebook-production-2026-09-17.1",
"charged_amount": "0.39",
"currency": "CNY"
}
}Complete and empty results are charged; partial results and failures are not.
The field summary is for scanning; the full JSON Schema is the stable output contract.
FieldcodeTypenumberConstraints and defaultsconst: 200RequirementRequiredFieldrequest_idTypestringConstraints and defaultsNo additional constraintsRequirementRequiredFieldmessageTypestringConstraints and defaultsconst: "success"RequirementRequiredFielddataTypeobjectConstraints and defaultsNo additional constraintsRequirementRequiredFieldpageTypeobjectConstraints and defaultsNo additional constraintsRequirementRequiredFieldwarningsTypearrayConstraints and defaultsNo additional constraintsRequirementRequiredFieldmetaTypeobjectConstraints and defaultsNo additional constraintsRequirementRequired{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"code": {
"type": "number",
"const": 200
},
"request_id": {
"type": "string"
},
"message": {
"type": "string",
"const": "success"
},
"data": {
"type": "object",
"properties": {
"creator_id": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"cover_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"published_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"note_type": {
"type": "string",
"enum": [
"image",
"video"
]
},
"reads": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"collects": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"offsite_readers": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"commercial": {
"type": "boolean"
},
"brand_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"title",
"cover_url",
"published_at",
"note_type",
"reads",
"likes",
"collects",
"offsite_readers",
"commercial",
"brand_name"
],
"additionalProperties": false
}
}
},
"required": [
"creator_id",
"items"
],
"additionalProperties": false
},
"page": {
"type": "object",
"properties": {
"page_number": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"page_size": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"has_more": {
"type": "boolean"
},
"next_page": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"page_number",
"page_size",
"total",
"has_more",
"next_page"
],
"additionalProperties": false
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"meta": {
"type": "object",
"properties": {
"listing_id": {
"type": "string",
"const": "xiaohongshu.pgy.bloggers.notes"
},
"version": {
"type": "string",
"const": "v1"
},
"catalog_release_id": {
"type": "string",
"minLength": 1
},
"price_book_version": {
"type": "string",
"minLength": 1
},
"result_status": {
"type": "string",
"enum": [
"complete",
"empty"
]
},
"charged_amount": {
"type": "string"
},
"balance_after": {
"type": "string"
},
"currency": {
"type": "string",
"const": "CNY"
}
},
"required": [
"listing_id",
"version",
"catalog_release_id",
"price_book_version",
"result_status",
"charged_amount",
"balance_after",
"currency"
],
"additionalProperties": false
}
},
"required": [
"code",
"request_id",
"message",
"data",
"page",
"warnings",
"meta"
],
"additionalProperties": false
}curl -X POST https://api.dataxapi.com/v1/xiaohongshu/pgy/bloggers/notes \
-H "Authorization: Bearer $DATAXAPI_API_KEY" \
-H "Idempotency-Key: your-stable-intent-key" \
-H "Content-Type: application/json" \
-d '{"user_id":"5c668b3e0000000012021605","page_number":1,"page_size":8}'[mcp_servers.dataxapi] url = "https://api.dataxapi.com/mcp" bearer_token_env_var = "DATAXAPI_API_KEY"
The same API key exposes only the precise tools in its scope. Keep the key in an environment variable, never in the config file. Reuse an explicit idempotency_key for safe retries.