{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu 小红书 RedNote Scraper - Notes, Comments & Replies", "description": "Scrape Xiaohongshu (小红书, RedNote, XHS, Little Red Book): search notes, topic feeds, note details, comments and replies, creator profiles, shop products and reviews. Commenters come with user ID, RED ID, avatar and IP location. No login or cookies needed. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "iadveiRA5fDcXEfXO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clover_folktale~xiaohongshu-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clover_folktale-xiaohongshu-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/clover_folktale~xiaohongshu-scraper/runs": { "post": { "operationId": "runs-sync-clover_folktale-xiaohongshu-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/clover_folktale~xiaohongshu-scraper/run-sync": { "post": { "operationId": "run-sync-clover_folktale-xiaohongshu-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "note", "comments", "user", "products", "reviews", "topic", "replies", "favorites", "userSearch", "imageSearch", "groupSearch", "similarProducts", "productDetail", "trends", "explore", "suggest", "hotNotes" ], "type": "string", "description": "What to scrape.", "default": "search" }, "keyword": { "title": "Keyword (modes: search, products, userSearch, imageSearch, groupSearch, suggest, hotNotes)", "type": "string", "description": "Search keyword. Chinese keywords return the best results. Mode suggest returns the platform's search suggestions for it; mode hotNotes returns the hot notes board filtered by it.", "default": "咖啡" }, "notes": { "title": "Notes (modes: note, comments, replies)", "type": "array", "description": "Note links or 24-character note IDs, e.g. https://www.xiaohongshu.com/explore/6aa72fd3000000002802c3f4. xhslink.com share links also work.", "items": { "type": "string" } }, "users": { "title": "Creators (modes: user, favorites)", "type": "array", "description": "Profile links or 24-character user IDs, e.g. https://www.xiaohongshu.com/user/profile/63ebbadf00000000260055d5. Mode favorites returns the notes the creator saved; creators who keep their collection private return nothing.", "items": { "type": "string" } }, "products": { "title": "Products (modes: reviews, similarProducts, productDetail)", "type": "array", "description": "Product links or 24-character product IDs, e.g. https://www.xiaohongshu.com/goods-detail/6a29427165e82f000132091b. Product IDs are returned by mode products.", "items": { "type": "string" } }, "topics": { "title": "Topics (modes: topic)", "type": "array", "description": "Topic page links or 24-character topic page IDs, e.g. https://www.xiaohongshu.com/page/topics/5c1cc866febed9000184b7c1.", "items": { "type": "string" } }, "includeReplies": { "title": "Include replies (mode: comments)", "type": "boolean", "description": "Also return the replies shown under each comment (the first replies the platform includes with the comment; long reply threads may be partial). Each reply is billed like a comment.", "default": false }, "includeOverview": { "title": "Include rating summary (mode: reviews)", "type": "boolean", "description": "Return one rating summary per product before its reviews (average rating, 1-5 star counts, buyer count). Billed as one detail.", "default": false }, "includeTopicInfo": { "title": "Include topic info (mode: topic)", "type": "boolean", "description": "Return one record per topic before its notes (name, views, discussions). Billed as one detail.", "default": false }, "category": { "title": "Channel (mode: explore)", "enum": [ "homefeed_recommend", "homefeed.fashion_v3", "homefeed.food_v3", "homefeed.cosmetics_v3", "homefeed.movie_and_tv_v3", "homefeed.kpop_v3", "homefeed.career_v3", "homefeed.love_v3", "homefeed.household_product_v3", "homefeed.gaming_v3", "homefeed.travel_v3", "homefeed.fitness_v3", "homefeed.video_v3" ], "type": "string", "description": "Discover-page channel whose notes to return. The list is the platform's own.", "default": "homefeed_recommend" }, "trendKind": { "title": "Trend type (mode: trends)", "enum": [ "hot", "inspiration" ], "type": "string", "description": "hot: the creator centre's hot topics ranked by viewers. inspiration: topics people are posting about, with post counts.", "default": "hot" }, "dateRange": { "title": "Time window in days (mode: hotNotes)", "enum": [ "3", "7", "14", "30" ], "type": "string", "description": "Only notes from the last 3, 7, 14 or 30 days. Leave empty for the board's own default window." }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of items to return in total for this run. You are charged per item returned.", "default": 20 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }