Skip to content
Xiaohongshu

xiaohongshu.notes.detail@v1

Xiaohongshu note detail

NoteDetail

Read the text, author, media, and public interaction snapshot for one image or video note using its ID and public Web security token.

POST/v1/xiaohongshu/notes/detail

Chinese name: 小红书笔记详情 · 笔记 · 详情
用笔记 ID 和公开 Web 安全令牌读取一条图文或视频笔记的正文、作者、媒体与互动快照。

Use it when

  • Use it after obtaining a note ID and xsec_token from a Xiaohongshu Web share or Web discovery result.

Do not use it for

  • Do not use it for search, comments, PGY commercial metrics, or private content.

Request parameters

Fieldnote_idTypestringConstraints and defaultspattern: "^[a-z0-9]{8,64}$"RequirementRequired
Fieldxsec_tokenTypestringConstraints and defaultsminLength: 8 · maxLength: 512RequirementRequired
Full request JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "note_id": {
      "type": "string",
      "pattern": "^[a-z0-9]{8,64}$"
    },
    "xsec_token": {
      "type": "string",
      "minLength": 8,
      "maxLength": 512
    }
  },
  "required": [
    "note_id",
    "xsec_token"
  ],
  "additionalProperties": false
}

Static response example

application/json
{
  "code": 200,
  "request_id": "req_example_xhs_note_detail_01",
  "message": "success",
  "data": {
    "item": {
      "id": "6a642d07000000001b01e343",
      "title": "Public note example",
      "body": "Public note body",
      "note_type": "image",
      "created_at": "2026-08-01T12:00:00.000Z",
      "updated_at": "2026-08-01T12:05:00.000Z",
      "author": {
        "id": "creator-01",
        "name": "Example creator",
        "avatar_url": "https://ci.xiaohongshu.com/avatar"
      },
      "media": {
        "images": [
          {
            "url": "https://ci.xiaohongshu.com/image",
            "width": 1200,
            "height": 1600
          }
        ],
        "video": null
      },
      "metrics": {
        "likes": 52,
        "collects": 18,
        "comments": 7,
        "shares": 3
      },
      "topics": [
        {
          "id": "topic-01",
          "name": "Example topic"
        }
      ]
    }
  },
  "page": {
    "next_cursor": null
  },
  "warnings": [],
  "meta": {
    "result_status": "complete",
    "balance_after": "0.81",
    "listing_id": "xiaohongshu.notes.detail",
    "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 confirmed empty results are charged; 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": {
        "item": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "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"
                    }
                  ]
                },
                "updated_at": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "author": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "avatar_url": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "avatar_url"
                  ],
                  "additionalProperties": false
                },
                "media": {
                  "type": "object",
                  "properties": {
                    "images": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "url": {
                            "type": "string"
                          },
                          "width": {
                            "anyOf": [
                              {
                                "type": "integer",
                                "exclusiveMinimum": 0,
                                "maximum": 9007199254740991
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "height": {
                            "anyOf": [
                              {
                                "type": "integer",
                                "exclusiveMinimum": 0,
                                "maximum": 9007199254740991
                              },
                              {
                                "type": "null"
                              }
                            ]
                          }
                        },
                        "required": [
                          "url",
                          "width",
                          "height"
                        ],
                        "additionalProperties": false
                      }
                    },
                    "video": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "url": {
                              "type": "string"
                            },
                            "cover_url": {
                              "anyOf": [
                                {
                                  "type": "string"
                                },
                                {
                                  "type": "null"
                                }
                              ]
                            },
                            "duration_seconds": {
                              "anyOf": [
                                {
                                  "type": "number",
                                  "minimum": 0
                                },
                                {
                                  "type": "null"
                                }
                              ]
                            },
                            "width": {
                              "anyOf": [
                                {
                                  "type": "integer",
                                  "exclusiveMinimum": 0,
                                  "maximum": 9007199254740991
                                },
                                {
                                  "type": "null"
                                }
                              ]
                            },
                            "height": {
                              "anyOf": [
                                {
                                  "type": "integer",
                                  "exclusiveMinimum": 0,
                                  "maximum": 9007199254740991
                                },
                                {
                                  "type": "null"
                                }
                              ]
                            }
                          },
                          "required": [
                            "url",
                            "cover_url",
                            "duration_seconds",
                            "width",
                            "height"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  "required": [
                    "images",
                    "video"
                  ],
                  "additionalProperties": false
                },
                "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"
                        }
                      ]
                    }
                  },
                  "required": [
                    "likes",
                    "collects",
                    "comments",
                    "shares"
                  ],
                  "additionalProperties": false
                },
                "topics": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "name": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "id",
                      "name"
                    ],
                    "additionalProperties": false
                  }
                }
              },
              "required": [
                "id",
                "title",
                "body",
                "note_type",
                "created_at",
                "updated_at",
                "author",
                "media",
                "metrics",
                "topics"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "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.notes.detail"
        },
        "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

  • Both the note ID and an xsec_token from a Xiaohongshu Web share or Web discovery result are required.
  • An xsec_token returned by App search is not compatible with this Web detail endpoint.
  • Media URLs can expire; V1 does not download or permanently host media.

Integration example

REST (cURL)

curl -X POST https://api.dataxapi.com/v1/xiaohongshu/notes/detail \
  -H "Authorization: Bearer $DATAXAPI_API_KEY" \
  -H "Idempotency-Key: your-stable-intent-key" \
  -H "Content-Type: application/json" \
  -d '{"note_id":"6a642d07000000001b01e343","xsec_token":"public-web-xsec-token"}'

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