ONEAPI / xiaohongshu

Xiaohongshu API

Connect Xiaohongshu creator profiles, note details, comments and search in a note-centered workflow. Several endpoint versions are documented, allowing developers to choose based on note type and input requirements instead of assuming identical responses across versions.

View platform documentation Register and create an API key

01 / CAPABILITIES

Available capabilities

Note details

Query a note by ID. Check each version’s inputs and image/video note support separately.

Endpoint documentation →

Note search

Discover notes using the documented search parameters, then retrieve details or comments as needed.

Endpoint documentation →

02 / USE CASES

What you can build

Brand content research

Combine keyword search results with note details to organize content around a brand or category.

Creator topic analysis

Use creator note lists and comment endpoints to review topics and reader feedback.

03 / REQUEST EXAMPLE

Look up a note using noteId

Replace YOUR_NOTE_ID with a real note ID. This example uses the base endpoint and its noteId parameter; consult the docs separately for other versions.

cURLPOST · JSON
curl --request POST 'https://api.getoneapi.com/api/xiaohongshu/fetch_video_detail' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "noteId" : "YOUR_NOTE_ID"
}'

Replace YOUR_API_KEY and the content placeholders with real values. This example uses cURL shell syntax; the Apifox docs provide Windows, Python and other examples. Live requests are billed according to your account configuration.

View full parameters and response documentation →

04 / FAQ

Frequently asked questions

Why does the note example use fetch_video_detail?

That is the actual route of the documented note-detail endpoint. The route name does not define note-type support across versions; check the selected endpoint’s documentation.

Can I switch between Xiaohongshu endpoint versions without changes?

Check parameter casing, note types, identifier or shared-link requirements and response formats before changing versions.