# SocialCrawl API: xiaohongshu endpoints
# Base URL: https://www.socialcrawl.dev
# Auth: x-api-key header
# Full docs: https://www.socialcrawl.dev/docs/xiaohongshu

## GET /v1/xiaohongshu/search
Search Xiaohongshu notes
Credit cost: 5-100 (metered): 5 credits per row RETURNED. The call holds `limit x 5` up front and settles down to the rows actually delivered. With `max_pages`, `max_items` or `max_credits`, each page walked is billed at this price (a cached page is free), and `max_credits` caps the total.
Parameters:
- query (required): Search keywords, for example 护肤 or camping.
- limit (optional, integer): Rows to return, 1 to 20. Default 10. Each row costs 5 credits and you are charged only for rows returned.
- cursor (optional, string): Continuation token from a previous response's pagination block. Omit for the first page.
- sort (optional, enum: relevance | latest | most_liked | most_commented | most_collected): Result ordering: relevance, latest, most_liked, most_commented, or most_collected. Default relevance.
- type (optional, enum: all | image | video): Note type: all, image, or video. Default all.
- published (optional, enum: all | day | week | half_year): Recency window: all, day, week, or half_year. Default all.
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
- max_pages (optional, integer): 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped.
- max_items (optional, integer): 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue.
- max_credits (optional, integer): 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price.
curl -G "https://www.socialcrawl.dev/v1/xiaohongshu/search" \
  --data-urlencode "query=护肤" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/xiaohongshu/trending
Get the Xiaohongshu hot search board
Credit cost: 5-100 (metered): 5 credits per row RETURNED. The call holds `limit x 5` up front and settles down to the rows actually delivered.
Parameters:
- limit (optional, integer): Topics to return, 1 to 20. Default 10. Each topic costs 5 credits and you are charged only for topics returned.
curl "https://www.socialcrawl.dev/v1/xiaohongshu/trending" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/xiaohongshu/profile
Get a Xiaohongshu creator
Credit cost: 5 (advanced)
Parameters:
- url (optional, string): Xiaohongshu profile URL, for example https://www.xiaohongshu.com/user/profile/6a59f257000000000f03b000.
- id (optional, string): User id, the author_user_id on a note. Not the RedNote id.
- Constraint: one of url, id (at least one required)
curl -G "https://www.socialcrawl.dev/v1/xiaohongshu/profile" \
  --data-urlencode "url=https://www.xiaohongshu.com/user/profile/6a59f257000000000f03b000" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/xiaohongshu/profile/posts
List a Xiaohongshu creator's notes
Credit cost: 5-100 (metered): 5 credits per row RETURNED. The call holds `limit x 5` up front and settles down to the rows actually delivered. With `max_pages`, `max_items` or `max_credits`, each page walked is billed at this price (a cached page is free), and `max_credits` caps the total.
Parameters:
- url (optional, string): Xiaohongshu profile URL.
- id (optional, string): User id, the author_user_id on a note. Not the RedNote id.
- limit (optional, integer): Rows to return, 1 to 20. Default 10. Each row costs 5 credits and you are charged only for rows returned.
- cursor (optional, string): Continuation token from a previous response's pagination block. Omit for the first page.
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
- max_pages (optional, integer): 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped.
- max_items (optional, integer): 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue.
- max_credits (optional, integer): 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price.
- Constraint: one of url, id (at least one required)
curl -G "https://www.socialcrawl.dev/v1/xiaohongshu/profile/posts" \
  --data-urlencode "url=https://www.xiaohongshu.com/user/profile/6a59f257000000000f03b000" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/xiaohongshu/post
Get a Xiaohongshu note
Credit cost: 5 (advanced)
Parameters:
- url (required): Note URL, for example https://www.xiaohongshu.com/explore/6aac8143000000002a007389, or the bare note id.
curl -G "https://www.socialcrawl.dev/v1/xiaohongshu/post" \
  --data-urlencode "url=https://www.xiaohongshu.com/explore/6aac8143000000002a007389" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/xiaohongshu/post/comments
Get Xiaohongshu note comments
Credit cost: 5-100 (metered): 5 credits per row RETURNED. The call holds `limit x 5` up front and settles down to the rows actually delivered. With `max_pages`, `max_items` or `max_credits`, each page walked is billed at this price (a cached page is free), and `max_credits` caps the total.
Parameters:
- url (required): Note URL or the bare note id the comments sit under.
- limit (optional, integer): Rows to return, 1 to 20. Default 10. Each row costs 5 credits and you are charged only for rows returned.
- cursor (optional, string): Continuation token from a previous response's pagination block. Omit for the first page.
- sort (optional, enum: relevance | latest | most_liked): Comment ordering: relevance, latest, or most_liked. Default relevance.
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
- max_pages (optional, integer): 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped.
- max_items (optional, integer): 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue.
- max_credits (optional, integer): 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price.
curl -G "https://www.socialcrawl.dev/v1/xiaohongshu/post/comments" \
  --data-urlencode "url=https://www.xiaohongshu.com/explore/6aac8143000000002a007389" \
  -H "x-api-key: YOUR_API_KEY"