Xiaohongshu

Get Xiaohongshu note

Get a Xiaohongshu note by id or link with its text, topics, images or video, and its counts.

GET/v1/xiaohongshu/notes/{noteId}
x-api-keystringheader

API key (`sfk_...`)

Parameters
2
noteIdstringrequiredpath

The note id, the 24 characters after `/explore/` or `/discovery/item/` in a note link, for example `68ad9c4b000000001b0339a6`. Most notes open only with the `xsec_token` of the link they were shared or listed with, so pass the whole note link (its token is read from it), the app's `xhslink.com` share link, or the id with `xsecToken`.

min 1 chars · max 1024 chars

xsecTokenstringoptionalquery

The `xsec_token` from the note's link (the value after `xsec_token=`). Needed for most notes: without it Xiaohongshu shows logged-out visitors only notes it currently promotes. Read from the link when you pass a whole note link as `noteId`.

pattern: ^[A-Za-z0-9_\-+/=]{16,256}$

Response fields
55

Endpoint-specific response payload.

datalookupStatus
string

`not_found` when Xiaohongshu refuses a note requested with an `xsec_token` (from the link or `xsecToken`): deleted, hidden or unknown. Without a token, a note Xiaohongshu will not show answers 400 `bad_request`, with no charge.

one of: found, not_found

The note when `lookupStatus` is `found`; otherwise null.

datanoteid
string

Note id.

datanoteurl
string

Note page.

datanotetype
stringnullable

`image` for a photo note, `video` for a video note.

one of: image, video, null

datanotetitle
stringnullable

Title.

datanotedescription
stringnullable

The note's text as plain text, with topics written `#name` and mentions `@name`.

datanotetitleTranslation
stringnullable

The site's English translation of the title, when it has one.

datanotedescriptionTranslation
stringnullable

The site's English translation of the text, when it has one.

datanotelanguage
stringnullable

The language the site detected, such as `zh_cn`.

datanotecreatedAt
stringnullable

When the note was posted, ISO 8601 UTC.

datanoteupdatedAt
stringnullable

When the note was last edited, ISO 8601 UTC.

datanoteipLocation
stringnullable

The region the site shows the note was posted from, when it shows one.

Topics on the note.

datanotetopics[]id
stringnullable

Topic id.

datanotetopics[]name
string

Topic name, without the `#`.

datanotetopics[]nameTranslation
stringnullable

The site's English translation of the name, when it has one.

Accounts the note mentions.

datanotementions[]id
string

Xiaohongshu user id, the same on every endpoint: pass it as `profileId` to the profile endpoints.

datanotementions[]displayName
stringnullable

Display name.

datanotementions[]avatarUrl
stringnullable

Profile picture.

datanotementions[]url
string

Profile page.

datanotecoverUrl
stringnullable

Cover image. A signed link that expires: download it, do not store it.

The images, in order. A video note has its cover here.

datanoteimages[]url
stringnullable

The full-size image. A signed link that expires: download it, do not store it.

datanoteimages[]previewUrl
stringnullable

A smaller preview of the image.

datanoteimages[]width
integernullable

Width in pixels.

datanoteimages[]height
integernullable

Height in pixels.

datanoteimages[]isLivePhoto
booleannullable

True when the image is a live photo (a short clip).

The video of a video note; null for a photo note.

datanotevideourl
stringnullable

The MP4 file. A signed link that expires: download it, do not store it.

Other copies of the same file, should `url` fail.

datanotevideobackupUrls[]
stringoptional
datanotevideodurationSeconds
numbernullable

Length in seconds, when known.

datanotevideowidth
integernullable

Width in pixels.

datanotevideoheight
integernullable

Height in pixels.

datanotevideobitrate
integernullable

Average bitrate in bits per second.

datanotevideosizeBytes
integernullable

File size in bytes.

Engagement counters as the site shows them. Counts of 10,000 and more are rounded by the site (`94.3K`).

datanotestatslikes
integernullable

Likes.

datanotestatssaves
integernullable

Saves (collects).

datanotestatscomments
integernullable

Comments.

datanotestatsshares
integernullable

Shares.

The creator.

datanoteauthorid
string

Xiaohongshu user id, the same on every endpoint: pass it as `profileId` to the profile endpoints.

datanoteauthordisplayName
stringnullable

Display name.

datanoteauthoravatarUrl
stringnullable

Profile picture.

datanoteauthorurl
string

Profile page.

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

metastale
booleanoptional

Present, and `true`, only when the source couldn't be reached and this is the last good answer for the same request instead, up to 24 hours old. Absent on every live answer.

one of: true

metafetchedAt
stringoptional

When a stale answer (`stale: true`) was originally fetched (ISO 8601, UTC). Absent on every live answer.

Code example

curl "https://api.socialfetch.dev/v1/xiaohongshu/notes/68ad9c4b000000001b0339a6" \
  -H "x-api-key: YOUR_API_KEY"

Responses

A Xiaohongshu note.