{ "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 } } } } } } } } } }