Rednote User Notes
Rednote user notes are public account publications with text, author attribution, media, publication time, and visible engagement counts. These content and context fields support account research, publishing-pattern review, format comparison, and point-in-time performance analysis.
Rednote User Notes API Features
- Two account identity inputs with defined precedenceAccept either a supported Rednote user reference or user_id, using the explicit user_id when both fields are supplied.
- One-page account note collectionThe Rednote User Notes API retrieves the public notes returned by one source request for the selected account without exposing a source cursor or caller-defined result limit.
- Normalized note and author contextReturn note IDs, public URLs, text, author identity, media references, publication time, and collection time in a consistent PostItem structure.
- Visible engagement snapshotsPreserve available like, comment, share, and view counts together with collected_at for time-bounded comparison.
Rednote User Notes API Parameters
| Parameters | Required | Description |
|---|---|---|
url | Required (at least one) | A non-empty Rednote user reference whose parsed hostname is xiaohongshu.com, xhslink.com, or a subdomain of either host. No path pattern is required; when the URL contains /user/<identifier> and user_id is blank, that identifier is used, otherwise the accepted URL remains the account reference. |
user_id | Required (at least one) | A Rednote user identifier containing 1 to 256 ASCII letters, numbers, colons, underscores, or hyphens. Provide url or user_id; when both are present, the explicit user_id takes precedence. |
How to Use the Rednote User Notes API
Give the Rednote User Notes API one supported account identity, track the asynchronous task, then page through its stored normalized note records.
- Prepare either a non-empty Rednote user URL on an accepted host or a valid user_id; leave the other field blank when it is not needed.
- POST url or user_id to /v1/rednote/user-notes and save the returned task_id.
- Poll /v1/tasks/{task_id} until the task succeeds or reports a failure.
- Read data.results.items and follow next_cursor while has_more is true; this cursor paginates stored records, not additional Rednote source pages.
curl -X POST "https://api.socq.ai/v1/rednote/user-notes" \
-H "Authorization: Bearer $SOCQ_API_KEY" \
-H "Content-Type: application/json" \
-d "{\"url\":\"$REDNOTE_USER_URL\"}"
# Poll GET /v1/tasks/{task_id}
# Read data.results.items and follow next_cursor while has_more is trueRednote User Notes API Use Cases
- Public account publication inventory: Use note IDs, public URLs, text, author attribution, and publication time to catalog the returned account snapshot.
- Content format review: Compare available image and video references, dimensions, thumbnails, and note text across the account notes returned by the Rednote User Notes API.
- Publishing-pattern analysis: Order notes by published_at and examine text and media together to review the account's visible publishing mix within the snapshot.
- Point-in-time engagement comparison: Compare visible likes, comments, shares, and views while using collected_at to keep each observation tied to its collection time.
Rednote User Notes API Pro Tips
- Use a stable user_id when you already have one; it takes precedence over url and avoids ambiguity between two account references.
- When submitting url, validate its hostname against xiaohongshu.com or xhslink.com; no specific path pattern is required.
- If a supported URL contains /user/<identifier>, confirm that the path identifies the intended account because that identifier is used when user_id is blank.
- Do not add results_limit or a source cursor to a Rednote User Notes API submission; each task makes one source request for one page.
- Use cursor and limit only on GET /v1/tasks/{task_id} after completion; limit defaults to 50 and accepts 1 through 500 for stored results.
- Treat text, author fields, media, publication time, hashtags, mentions, and individual metrics as nullable, and escape public text before rendering it.
Related APIs
Beyond the Rednote User Notes API, use these APIs when you need a different type of public Rednote data.