{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu 小红书 Scraper - RedNote Notes, Users & Comments", "description": "Scrape Xiaohongshu / RedNote (小红书): keyword note search, full note details, creator profiles, a creator's posted notes, and note comments. Export likes, collects, comments, images, video and creator data to JSON/CSV/Excel. No login, cookies or proxy needed.", "version": "1.0", "x-build-id": "Pp8EdWLms5WLDuGvn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vulnv~xiaohongshu-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vulnv-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/vulnv~xiaohongshu-scraper/runs": { "post": { "operationId": "runs-sync-vulnv-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/vulnv~xiaohongshu-scraper/run-sync": { "post": { "operationId": "run-sync-vulnv-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": [ "operation" ], "properties": { "operation": { "title": "⚙️ Operation", "enum": [ "search_notes", "note_detail", "note_comments", "user_profile", "user_notes" ], "type": "string", "description": "What to scrape. Each operation uses a different input field below:\n\n• Search notes → Keywords\n• Note details → Note URLs / IDs\n• Note comments → Note URLs / IDs\n• Creator profile → Creator URLs / IDs\n• Creator's notes → Creator URLs / IDs", "default": "search_notes" }, "keywords": { "title": "🔎 Search keywords", "type": "array", "description": "For the \"Search notes\" operation. Add one or more keywords - Chinese, English, brand names and emoji all work. Each keyword is searched independently and cross-keyword duplicates are removed.", "items": { "type": "string" } }, "noteUrls": { "title": "📝 Note URLs / IDs", "type": "array", "description": "For the \"Note details\" and \"Note comments\" operations. Paste full note URLs, share links, or bare note IDs - one per line.", "items": { "type": "string" } }, "userUrls": { "title": "👤 Creator URLs / IDs", "type": "array", "description": "For the \"Creator profile\" and \"Creator's posted notes\" operations. Paste full profile URLs, share links, or bare user IDs - one per line.", "items": { "type": "string" } }, "maxItems": { "title": "📊 Maximum results per input", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Upper bound on results per keyword / creator / note (for the paginated operations: search, creator's notes, comments). Cost scales linearly. Set 0 to fetch all available.", "default": 100 }, "searchSort": { "title": "📈 Search sort order", "enum": [ "general", "most_liked", "latest" ], "type": "string", "description": "For \"Search notes\" only. How Xiaohongshu orders results.", "default": "general" }, "noteType": { "title": "🎞️ Note type", "enum": [ "all", "video", "image" ], "type": "string", "description": "For \"Search notes\" only. Limit to a note format.", "default": "all" }, "timeFilter": { "title": "📅 Published in", "enum": [ "all", "one_day", "one_week", "half_year" ], "type": "string", "description": "For \"Search notes\" only. Limit results to notes published within this window.", "default": "all" }, "commentSort": { "title": "💬 Comment sort order", "enum": [ "latest", "most_liked", "default" ], "type": "string", "description": "For \"Note comments\" only. How to order the returned comments.", "default": "latest" } } }, "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 } } } } } } } } } }