/xiaohongshu/notes

POST /api/xiaohongshu/notes

Price: 20 credits

Get Xiaohongshu (RED, 小红书) note details by note ID or full note URL

How to use it

Get full details of a Xiaohongshu (RED, 小红书) note by note ID or note URL. Returns type (video/normal), title, text, hashtags, mentions, images, video, author, created time, like/collect/comment/share counts. A note ID requires an xsec_token (present in note/feed/search URLs).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• note string required — Xiaohongshu note ID ('64b8140a0000000016027186') or full note URL. When a bare note ID is given, xsec_token is required. (examples: "https://www.xiaohongshu.com/explore/64b8140a0000000016027186?xsec_token=AB_yBVYPZ09gPsXTE6JBbohIwoiaw3RXja90dH-LsHrnk=", "64b8140a0000000016027186"; minLength: 1; pattern: ^(?:https?://[^\s]+|[0-9a-fA-F]{24})$)
• xsec_token string nullable — Access token bound to the note, found in note/feed/search URLs. Required for a bare note ID.

Response

• @type string (default: "XiaohongshuNote")
• id string required
• type string nullable
• text string nullable
• hashtags array (default: [])
• mentions array (default: [])
  • @type string (default: "XiaohongshuUser")
  • id string required
  • nickname string nullable
  • red_id string nullable
  • image string nullable
  • xsec_token string nullable
  • profile_url string nullable
• images array (default: [])
• video object nullable
  • @type string (default: "XiaohongshuNoteVideo")
  • play_url string nullable
  • duration integer nullable
  • width integer nullable
  • height integer nullable
• author object nullable
  • @type string (default: "XiaohongshuUser")
  • id string required
  • nickname string nullable
  • red_id string nullable
  • image string nullable
  • xsec_token string nullable
  • profile_url string nullable
• created_at integer nullable
• last_update_at integer nullable
• ip_location string nullable
• like_count integer nullable
• collect_count integer nullable
• comment_count integer nullable
• share_count integer nullable
• note_url string nullable
• xsec_token string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Note not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.