# 📕 RedNote (Xiaohongshu) All-in-One Scraper (`ethereal_wool/xiaohongshu-all-in-one-scraper`) Actor All-in-one RedNote / Xiaohongshu / 小红书 scraper: search notes, scrape a creator's notes, pull note comments, search the mall, get product detail, and fetch the trending hot list — one Actor, six jobs. No login, clean flat JSON, pay per result. - **URL**: https://apify.com/ethereal\_wool/xiaohongshu-all-in-one-scraper.md - **Developed by:** [Jackie Chen](https://apify.com/ethereal_wool) (community) - **Categories:** Social media, E-commerce - **Stats:** 5 total users, 3 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing $4.00 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Xiaohongshu (RedNote) All-in-One Scraper One Actor for everything you need from **Xiaohongshu / 小红书 / RedNote** — notes, creators, comments, mall products, and trending — with clean, flat JSON output. No login, no cookies, no browser automation to babysit. Fill in only the inputs you care about; each one turns on a capability: | Input | What you get | |---|---| | **Note search keywords** | Notes matching a keyword (title, body, likes, collects, comments, author, images/video, URL) | | **User IDs** | Every note posted by a creator | | **Product search keywords** | RedNote mall products (price, original price, vendor, stock, SKU count, images) | | **Product IDs** | Full product detail (title, price, image carousel, full SKU / variant list) | | **Include trending** | The live RedNote hot-search list with rank + heat score | | **Include note comments** | Top-level comments attached to each scraped note | Every output row carries a `dataType` field (`note` / `product` / `trending`) so a mixed run is trivial to split downstream. ### Example input ```json { "searchKeywords": ["护肤", "city walk"], "productKeywords": ["面膜"], "includeTrending": true, "includeComments": true, "maxCommentsPerNote": 5, "maxItems": 200, "sortType": "popularity_descending" } ```` ### Example output (a note) ```json { "dataType": "note", "noteId": "655...e4", "url": "https://www.xiaohongshu.com/explore/655...e4", "type": "video", "title": "敏感肌护肤避坑指南", "description": "...", "likedCount": 25431, "collectedCount": 8120, "commentsCount": 642, "coverUrl": "https://...", "author": { "userId": "5a3...a2", "nickname": "..." }, "comments": [{ "content": "太有用了", "likeCount": 31 }] } ``` ### Use cases - **Trend & content research** — find the best-performing notes and live hot-search topics for any keyword. - **Influencer / KOL discovery** — pull a creator's full note history and engagement. - **E-commerce & pricing** — track mall products, prices, vendors and SKUs for competitive research. - **Social listening** — collect notes + comments to gauge sentiment around a brand or product. - **Feed an LLM / agent** — flat JSON that drops straight into RAG, analysis, or automation pipelines. ### Output One item per note / product / trending word, pushed to the dataset. Export to JSON, CSV, Excel, or pull via the Apify API. Pricing is pay-per-result, so you only pay for what you scrape. ### Notes - Chinese keywords return the most complete results. - User IDs are the 24-character hex id from a profile URL (e.g. `5a34cd1811be103ff72f06a2`). - For very large jobs you can route requests through Apify Proxy in the input. # Actor input Schema ## `searchKeywords` (type: `array`): Keywords to search RedNote notes for. Each keyword is searched and paginated independently. Chinese keywords return the most results. ## `userIds` (type: `array`): Xiaohongshu user IDs (the 24-character hex id from a profile URL, e.g. 5a34cd1811be103ff72f06a2) whose posted notes you want to scrape. ## `productKeywords` (type: `array`): Keywords to search the RedNote mall (商城) for. Returns product cards with price, vendor, stock and SKU info. ## `productIds` (type: `array`): RedNote product / SKU ids to fetch full detail for (title, price, image carousel, full SKU/variant list). ## `includeTrending` (type: `boolean`): Also fetch the current RedNote trending hot-search words with their rank and heat score. ## `maxItems` (type: `integer`): Maximum total number of items to scrape across all sources (notes + products + trending). ## `sortType` (type: `string`): How to sort keyword note-search results. ## `noteType` (type: `string`): Filter note-search results by note type. ## `includeComments` (type: `boolean`): Also fetch top-level comments for each scraped note. Slower and uses more API calls. ## `maxCommentsPerNote` (type: `integer`): Maximum top-level comments to fetch per note when 'Include note comments' is enabled. ## `productSort` (type: `string`): Optional sort for product search (leave empty for default relevance). ## `minPrice` (type: `string`): Optional minimum price filter for product search. ## `maxPrice` (type: `string`): Optional maximum price filter for product search. ## `proxyConfiguration` (type: `object`): Optional. Route the upstream API calls through an Apify Proxy to vary the source IP if the upstream ever rate-limits the datacenter range. ## Actor input object example ```json { "searchKeywords": [ "护肤" ], "userIds": [], "productKeywords": [], "productIds": [], "includeTrending": false, "maxItems": 50, "sortType": "general", "noteType": "不限", "includeComments": false, "maxCommentsPerNote": 10, "proxyConfiguration": { "useApifyProxy": false } } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "searchKeywords": [ "护肤" ] }; // Run the Actor and wait for it to finish const run = await client.actor("ethereal_wool/xiaohongshu-all-in-one-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "searchKeywords": ["护肤"] } # Run the Actor and wait for it to finish run = client.actor("ethereal_wool/xiaohongshu-all-in-one-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "searchKeywords": [ "护肤" ] }' | apify call ethereal_wool/xiaohongshu-all-in-one-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=ethereal_wool/xiaohongshu-all-in-one-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "📕 RedNote (Xiaohongshu) All-in-One Scraper", "description": "All-in-one RedNote / Xiaohongshu / 小红书 scraper: search notes, scrape a creator's notes, pull note comments, search the mall, get product detail, and fetch the trending hot list — one Actor, six jobs. No login, clean flat JSON, pay per result.", "version": "0.1", "x-build-id": "ZG4O02E3255oykQS9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ethereal_wool~xiaohongshu-all-in-one-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ethereal_wool-xiaohongshu-all-in-one-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/ethereal_wool~xiaohongshu-all-in-one-scraper/runs": { "post": { "operationId": "runs-sync-ethereal_wool-xiaohongshu-all-in-one-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/ethereal_wool~xiaohongshu-all-in-one-scraper/run-sync": { "post": { "operationId": "run-sync-ethereal_wool-xiaohongshu-all-in-one-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "searchKeywords": { "title": "Note search keywords", "type": "array", "description": "Keywords to search RedNote notes for. Each keyword is searched and paginated independently. Chinese keywords return the most results.", "items": { "type": "string" } }, "userIds": { "title": "User IDs (creator notes)", "type": "array", "description": "Xiaohongshu user IDs (the 24-character hex id from a profile URL, e.g. 5a34cd1811be103ff72f06a2) whose posted notes you want to scrape.", "default": [], "items": { "type": "string" } }, "productKeywords": { "title": "Product search keywords", "type": "array", "description": "Keywords to search the RedNote mall (商城) for. Returns product cards with price, vendor, stock and SKU info.", "default": [], "items": { "type": "string" } }, "productIds": { "title": "Product IDs (detail)", "type": "array", "description": "RedNote product / SKU ids to fetch full detail for (title, price, image carousel, full SKU/variant list).", "default": [], "items": { "type": "string" } }, "includeTrending": { "title": "Include trending hot list", "type": "boolean", "description": "Also fetch the current RedNote trending hot-search words with their rank and heat score.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum total number of items to scrape across all sources (notes + products + trending).", "default": 50 }, "sortType": { "title": "Note sort order", "enum": [ "general", "time_descending", "popularity_descending" ], "type": "string", "description": "How to sort keyword note-search results.", "default": "general" }, "noteType": { "title": "Note type filter", "enum": [ "不限", "视频笔记", "普通笔记" ], "type": "string", "description": "Filter note-search results by note type.", "default": "不限" }, "includeComments": { "title": "Include note comments", "type": "boolean", "description": "Also fetch top-level comments for each scraped note. Slower and uses more API calls.", "default": false }, "maxCommentsPerNote": { "title": "Max comments per note", "minimum": 0, "maximum": 500, "type": "integer", "description": "Maximum top-level comments to fetch per note when 'Include note comments' is enabled.", "default": 10 }, "productSort": { "title": "Product sort order", "type": "string", "description": "Optional sort for product search (leave empty for default relevance)." }, "minPrice": { "title": "Min product price (CNY)", "type": "string", "description": "Optional minimum price filter for product search." }, "maxPrice": { "title": "Max product price (CNY)", "type": "string", "description": "Optional maximum price filter for product search." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Route the upstream API calls through an Apify Proxy to vary the source IP if the upstream ever rate-limits the datacenter range.", "default": { "useApifyProxy": false } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```