Skip to content
Xiaohongshu

xiaohongshu.pgy.bloggers.fans.summary@v1

Xiaohongshu PGY audience summary

PGY Blogger AudienceSummary

Read aggregate audience size, growth, and quality metrics.

POST/v1/xiaohongshu/pgy/bloggers/fans/summary

Chinese name: 小红书蒲公英博主粉丝概览 · 蒲公英博主受众 · 概览
读取粉丝规模、增长和受众质量聚合指标。

Use it when

  • Use it for a quick assessment of audience size, growth, and quality.

Do not use it for

  • Do not use it for demographic distributions or daily growth.

Request parameters

Fielduser_idTypestringConstraints and defaultspattern: "^[a-f0-9]{24}$"RequirementRequired
Full request JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "user_id": {
      "type": "string",
      "pattern": "^[a-f0-9]{24}$"
    }
  },
  "required": [
    "user_id"
  ],
  "additionalProperties": false
}

Static response example

application/json
{
  "code": 200,
  "request_id": "req_example_pgy_fans_summary",
  "message": "success",
  "data": {
    "creator_id": "5c668b3e0000000012021605",
    "item": {
      "followers_count": 123456,
      "follower_growth": 3456,
      "follower_growth_rate": 2.88,
      "audience": {
        "active": {
          "value": 67890,
          "peer_surpass_rate": 88.2
        },
        "engaged": {
          "value": 18234,
          "peer_surpass_rate": 82.5
        },
        "reading": {
          "value": 45678,
          "peer_surpass_rate": 79.1
        },
        "paid": {
          "value": 9876,
          "peer_surpass_rate": null
        }
      }
    }
  },
  "page": {
    "next_cursor": null
  },
  "warnings": [],
  "meta": {
    "result_status": "complete",
    "balance_after": "49.61",
    "listing_id": "xiaohongshu.pgy.bloggers.fans.summary",
    "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"
  }
}

Unavailable while paused

Complete and empty results are charged; partial results and failures are not.

Response contract

The field summary is for scanning; the full JSON Schema is the stable output contract.

FieldcodeTypenumberConstraints and defaultsconst: 200RequirementRequired
Fieldrequest_idTypestringConstraints and defaultsminLength: 1RequirementRequired
FieldmessageTypestringConstraints and defaultsconst: "success"RequirementRequired
FielddataTypeobjectConstraints and defaultsNo additional constraintsRequirementRequired
FieldpageTypeobjectConstraints and defaultsNo additional constraintsRequirementRequired
FieldwarningsTypearrayConstraints and defaultsNo additional constraintsRequirementRequired
FieldmetaTypeobjectConstraints and defaultsNo additional constraintsRequirementRequired
Full response JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "const": 200
    },
    "request_id": {
      "type": "string",
      "minLength": 1
    },
    "message": {
      "type": "string",
      "const": "success"
    },
    "data": {
      "type": "object",
      "properties": {
        "creator_id": {
          "type": "string",
          "pattern": "^[a-f0-9]{24}$"
        },
        "item": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "followers_count": {
                  "anyOf": [
                    {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 9007199254740991
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "follower_growth": {
                  "anyOf": [
                    {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "follower_growth_rate": {
                  "anyOf": [
                    {
                      "type": "number",
                      "minimum": 0
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "audience": {
                  "type": "object",
                  "properties": {
                    "active": {
                      "type": "object",
                      "properties": {
                        "value": {
                          "anyOf": [
                            {
                              "type": "number",
                              "minimum": 0
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "peer_surpass_rate": {
                          "anyOf": [
                            {
                              "type": "number",
                              "minimum": 0
                            },
                            {
                              "type": "null"
                            }
                          ]
                        }
                      },
                      "required": [
                        "value",
                        "peer_surpass_rate"
                      ],
                      "additionalProperties": false
                    },
                    "engaged": {
                      "type": "object",
                      "properties": {
                        "value": {
                          "anyOf": [
                            {
                              "type": "number",
                              "minimum": 0
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "peer_surpass_rate": {
                          "anyOf": [
                            {
                              "type": "number",
                              "minimum": 0
                            },
                            {
                              "type": "null"
                            }
                          ]
                        }
                      },
                      "required": [
                        "value",
                        "peer_surpass_rate"
                      ],
                      "additionalProperties": false
                    },
                    "reading": {
                      "type": "object",
                      "properties": {
                        "value": {
                          "anyOf": [
                            {
                              "type": "number",
                              "minimum": 0
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "peer_surpass_rate": {
                          "anyOf": [
                            {
                              "type": "number",
                              "minimum": 0
                            },
                            {
                              "type": "null"
                            }
                          ]
                        }
                      },
                      "required": [
                        "value",
                        "peer_surpass_rate"
                      ],
                      "additionalProperties": false
                    },
                    "paid": {
                      "type": "object",
                      "properties": {
                        "value": {
                          "anyOf": [
                            {
                              "type": "number",
                              "minimum": 0
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "peer_surpass_rate": {
                          "anyOf": [
                            {
                              "type": "number",
                              "minimum": 0
                            },
                            {
                              "type": "null"
                            }
                          ]
                        }
                      },
                      "required": [
                        "value",
                        "peer_surpass_rate"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "required": [
                    "active",
                    "engaged",
                    "reading",
                    "paid"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "followers_count",
                "follower_growth",
                "follower_growth_rate",
                "audience"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "creator_id",
        "item"
      ],
      "additionalProperties": false
    },
    "page": {
      "type": "object",
      "properties": {
        "next_cursor": {
          "type": "null"
        }
      },
      "required": [
        "next_cursor"
      ],
      "additionalProperties": false
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "listing_id": {
          "type": "string",
          "const": "xiaohongshu.pgy.bloggers.fans.summary"
        },
        "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
}

Known limitations

  • Metrics are point-in-time aggregates.
  • Peer-surpass rates follow PGY's current sample and methodology.
  • Metrics may be null when samples are insufficient.

Integration example

REST (cURL)

curl -X POST https://api.dataxapi.com/v1/xiaohongshu/pgy/bloggers/fans/summary \
  -H "Authorization: Bearer $DATAXAPI_API_KEY" \
  -H "Idempotency-Key: your-stable-intent-key" \
  -H "Content-Type: application/json" \
  -d '{"user_id":"5c668b3e0000000012021605"}'

Exact MCP Preview (Codex config)

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

View client compatibility →

Catalog release: catalog-production-2026-09-17.1 · PriceBook: pricebook-production-2026-09-17.1