Skip to content
Xiaohongshu

xiaohongshu.users.notes@v1

Xiaohongshu user notes

NoteList By User

Read one page of a known user's public posted notes.

POST/v1/xiaohongshu/users/notes

Chinese name: 小红书用户笔记 · 笔记 · 按用户列出
按用户 ID 或分享文本读取一页公开发布笔记。

Use it when

  • Use it to read public notes posted by a known Xiaohongshu user.

Do not use it for

  • Do not use it for favorites, private content, or complete history.

Request parameters

The request body must match one of these parameter sets.

Input option 1

Fielduser_idTypestringConstraints and defaultsminLength: 1 · maxLength: 128RequirementRequired
FieldcursorTypestringConstraints and defaultsminLength: 1RequirementOptional

Input option 2

Fieldshare_textTypestringConstraints and defaultsminLength: 8 · maxLength: 2048RequirementRequired
FieldcursorTypestringConstraints and defaultsminLength: 1RequirementOptional
Full request JSON Schema
{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "user_id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "share_text": {
          "not": {}
        },
        "cursor": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "user_id"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "share_text": {
          "type": "string",
          "minLength": 8,
          "maxLength": 2048
        },
        "user_id": {
          "not": {}
        },
        "cursor": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "share_text"
      ],
      "additionalProperties": false
    }
  ]
}

Static response example

application/json
{
  "code": 200,
  "request_id": "req_example_xhs_user_notes_01",
  "message": "success",
  "data": {
    "items": [
      {
        "id": "note-01",
        "title": "Public note",
        "body": "Public note body",
        "note_type": "image",
        "created_at": "2026-08-01T12:00:00.000Z",
        "cover_url": "https://ci.xiaohongshu.com/cover",
        "metrics": {
          "likes": 20,
          "collects": 3,
          "comments": 2,
          "shares": 1,
          "views": null
        }
      }
    ]
  },
  "page": {
    "next_cursor": "opaque-cursor"
  },
  "warnings": [
    "views_unavailable"
  ],
  "meta": {
    "result_status": "complete",
    "balance_after": "0.81",
    "listing_id": "xiaohongshu.users.notes",
    "version": "v1",
    "catalog_release_id": "catalog-production-2026-09-17.1",
    "price_book_version": "pricebook-production-2026-09-17.1",
    "charged_amount": "0.19",
    "currency": "CNY"
  }
}

Run live

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

Security check

Loading the security check…

Checking live execution status…

Execution result

// Result

Response contract

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

FieldcodeTypenumberConstraints and defaultsconst: 200RequirementRequired
Fieldrequest_idTypestringConstraints and defaultsNo additional constraintsRequirementRequired
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"
    },
    "message": {
      "type": "string",
      "const": "success"
    },
    "data": {
      "type": "object",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1
              },
              "title": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "body": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "note_type": {
                "type": "string",
                "enum": [
                  "image",
                  "video"
                ]
              },
              "created_at": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "cover_url": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "metrics": {
                "type": "object",
                "properties": {
                  "likes": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "collects": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "comments": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "shares": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "views": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                "required": [
                  "likes",
                  "collects",
                  "comments",
                  "shares",
                  "views"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "id",
              "title",
              "body",
              "note_type",
              "created_at",
              "cover_url",
              "metrics"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "items"
      ],
      "additionalProperties": false
    },
    "page": {
      "type": "object",
      "properties": {
        "next_cursor": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "next_cursor"
      ],
      "additionalProperties": false
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "listing_id": {
          "type": "string",
          "const": "xiaohongshu.users.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",
            "partial"
          ]
        },
        "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

  • Continue only with this Listing's Cursor; complete history is not guaranteed.
  • When public views are unavailable, views is null and warnings contains views_unavailable.

Integration example

REST (cURL)

curl -X POST https://api.dataxapi.com/v1/xiaohongshu/users/notes \
  -H "Authorization: Bearer $DATAXAPI_API_KEY" \
  -H "Idempotency-Key: your-stable-intent-key" \
  -H "Content-Type: application/json" \
  -d '{"user_id":"625fb6ee0000000010005270"}'

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