{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu (RedNote) Scraper - Notes, Comments, Profiles", "description": "Scrape Xiaohongshu (RedNote, 小红书) without login: note details from note links (text, images, video, tags, likes, saves, comments, shares, date, location), note comments with replies, public profiles with their latest notes, and trending notes from the Explore feed.", "version": "0.1", "x-build-id": "mhDL6BSTwfz3LO7fU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automly~xiaohongshu-rednote-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automly-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/automly~xiaohongshu-rednote-scraper/runs": { "post": { "operationId": "runs-sync-automly-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/automly~xiaohongshu-rednote-scraper/run-sync": { "post": { "operationId": "run-sync-automly-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": { "mode": { "title": "What to scrape", "enum": [ "explore", "notes", "comments", "profiles" ], "type": "string", "description": "Choose one kind of data per run: Explore feed notes (trending notes by channel, no links needed), note details from note links, the comments of notes, or public profiles.", "default": "explore" }, "channels": { "title": "Explore channels", "type": "array", "description": "For Explore feed notes: the Explore channels to read, e.g. recommend, food or travel. Recommended gives the notes recommended right now; the topic channels give popular notes, many of them older. Notes are split evenly between the channels chosen.", "items": { "type": "string", "enum": [ "recommend", "fashion", "food", "cosmetics", "movies_tv", "career", "relationships", "home", "gaming", "travel", "fitness", "video" ], "enumTitles": [ "Recommended (For you)", "Fashion (穿搭)", "Food (美食)", "Makeup (彩妆)", "Movies & TV (影视)", "Career (职场)", "Relationships (情感)", "Home (家居)", "Gaming (游戏)", "Travel (旅行)", "Fitness (健身)", "Videos (视频)" ] }, "default": [ "recommend" ] }, "exploreDetails": { "title": "Open every Explore note for full details", "type": "boolean", "description": "For Explore feed notes: save each note's full details (text, all images, video link, tags, saves, comments, shares, date and location) instead of the feed card (title, cover, likes, author).", "default": false }, "noteUrls": { "title": "Note links", "type": "array", "description": "For Note details and Comments: note links copied from the browser address bar or the app's share button, e.g. https://www.xiaohongshu.com/explore/6a9f534d0000000012025f7b?xsec_token=AB9w...&xsec_source=pc_feed, an xhslink.com link or the whole share text. Copy the whole link: Xiaohongshu opens a note only with the part after the question mark, and only for a limited time after you copy it.", "items": { "type": "string" } }, "profiles": { "title": "Profiles", "type": "array", "description": "For Profiles: profile links or 24-character user IDs, e.g. https://www.xiaohongshu.com/user/profile/614b734f0000000002020ac2 or 614b734f0000000002020ac2.", "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "The most rows this run saves in total (notes, comments or profiles), e.g. 100. The run stops as soon as it has this many.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "The default works for most runs. If results come back empty, try a different proxy option.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }