{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu Scraper: RedNote Notes, Profiles, Trending", "description": "Xiaohongshu (RedNote, 小红书) scraper: note details from a link, creator profiles with followers and recent notes, and trending feeds by category. $3 per 1,000 notes or profiles. No login, no browser. No keyword search or comments.", "version": "0.1", "x-build-id": "E6QwQrhoRLet9S9bK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datagleaner~xiaohongshu-rednote-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datagleaner-xiaohongshu-rednote-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/datagleaner~xiaohongshu-rednote-scraper/runs": { "post": { "operationId": "runs-sync-datagleaner-xiaohongshu-rednote-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/datagleaner~xiaohongshu-rednote-scraper/run-sync": { "post": { "operationId": "run-sync-datagleaner-xiaohongshu-rednote-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": { "noteUrls": { "title": "Note URLs", "type": "array", "description": "Note links copied from Xiaohongshu / RedNote, e.g. `https://www.xiaohongshu.com/explore/?xsec_token=...`, an `xhslink.com` short link, or the share text the app copies. The `xsec_token` part is required: Xiaohongshu refuses a bare note ID or a link without it. Returns the full note (text, tags, counts, images, video link).", "items": { "type": "string" } }, "profileUrls": { "title": "Profile URLs", "type": "array", "description": "User profile links, e.g. `https://www.xiaohongshu.com/user/profile/` (a token is optional), or an `xhslink.com` short link. Returns one profile record with follower and like counts, and its newest notes (up to about 30) in `recentNotes` with title, likes, publish time and cover.", "items": { "type": "string" } }, "feedChannels": { "title": "Discovery feed channels", "type": "array", "description": "Public discovery feeds. Each page load returns about 35 notes the site recommends (not necessarily recent) with title, author, like count, creation time and cover. Leave note URLs and profile URLs empty to scrape these.", "items": { "type": "string", "enum": [ "recommend", "fashion", "food", "cosmetics", "movie_and_tv", "career", "love", "household_product", "gaming", "travel", "fitness" ], "enumTitles": [ "Recommended", "Fashion", "Food", "Beauty", "Film and TV", "Career", "Relationships", "Home", "Gaming", "Travel", "Fitness" ] } }, "maxItems": { "title": "Max notes per feed channel or profile", "minimum": 1, "maximum": 500, "type": "integer", "description": "Stop after this many notes per channel or profile. A feed page gives about 35 notes; more pages are fetched by reloading, and can repeat notes (duplicates are dropped). A profile page gives at most about 30.", "default": 20 }, "fetchNoteDetails": { "title": "Fetch full details for feed and profile notes", "type": "boolean", "description": "Feed notes carry a note ID and token, so each can be expanded into the full note (text, tags, publish time, comment, collect and share counts, video link) with one extra request. Profile notes cannot be expanded: Xiaohongshu hides their IDs from guests.", "default": false }, "requestDelaySecs": { "title": "Delay between requests (seconds)", "minimum": 1, "maximum": 60, "type": "number", "description": "Politeness pacing with random jitter.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Default is no proxy. Use Apify Proxy if Xiaohongshu blocks your run." } } }, "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 } } } } } } } } } }