{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu (RedNote) Scraper — Notes, Profiles & Search", "description": "Scrape Xiaohongshu (RedNote) notes, creator profiles, comments, and keyword search. Get likes, collects, images, video URLs, and hashtags — explore and note pages work with no login. Export JSON via API, Python, Node.js, or MCP.", "version": "0.1", "x-build-id": "NAb5GAaovTdmBX3YU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawloop~xiaohongshu-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawloop-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/crawloop~xiaohongshu-scraper/runs": { "post": { "operationId": "runs-sync-crawloop-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/crawloop~xiaohongshu-scraper/run-sync": { "post": { "operationId": "run-sync-crawloop-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", "properties": { "mode": { "title": "Mode", "enum": [ "explore", "note_detail", "user_profile", "user_notes" ], "type": "string", "description": "Public, no-login surfaces only: explore, note detail, user profile, and public user notes.", "default": "explore" }, "startUrls": { "title": "Note URLs / IDs", "type": "array", "description": "Public note pages for note_detail. Prefer the full URL with ?xsec_token=… copied from a public page. Also accepts xhslink.com share links and bare 24-character note IDs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "userUrls": { "title": "Profile URLs / user IDs", "type": "array", "description": "Creator profiles for user_profile and user_notes (https://www.xiaohongshu.com/user/profile/… or a 24-character user ID).", "items": { "type": "string" } }, "channel": { "title": "Explore channel", "enum": [ "recommend" ], "type": "string", "description": "Public SSR explore feed. Non-public channel APIs are out of scope; the Actor falls back to the public recommend feed.", "default": "recommend" }, "xsecToken": { "title": "xsec_token (fallback)", "type": "string", "description": "Used when a public note URL has no token. Public explore output includes xsecToken on note rows.", "default": "" }, "fullDetail": { "title": "Hydrate full note detail", "type": "boolean", "description": "Explore / user_notes: open each publicly accessible note and replace the card with full title, body, images, video URL, tags, and engagement counts. Slower (one HTML request per note).", "default": false }, "includeNotes": { "title": "Include creator notes (profile)", "type": "boolean", "description": "user_profile: also emit the creator's publicly accessible note cards. Anonymous pages may omit per-note IDs.", "default": false }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Hard cap on dataset rows for the whole run. 0 = no cap (Actor still stops at a safety limit). Default 50.", "default": 50 }, "maxPages": { "title": "Explore pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many times to reload the public explore feed. The recommend feed rotates, so extra pages usually add new unique notes (deduped by note ID).", "default": 1 }, "requestDelaySecs": { "title": "Delay between requests (seconds)", "minimum": 0, "maximum": 5, "type": "number", "description": "Throttle HTML/API calls. Raise if you see captchas (461/471) or empty SSR.", "default": 0.45 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify RESIDENTIAL is recommended. Datacenter IPs often hit Xiaohongshu's 安全限制 / 300011 wall.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }