{ "openapi": "3.0.1", "info": { "title": "RedNote (Xiaohongshu) Scraper", "description": "Scrape RedNote / Xiaohongshu (小红书) posts across four modes: trending, user_posts, hashtag, keyword_search. Extracts post id, author, title, body, images, hashtags, likes/comments/shares, posted-at timestamp.", "version": "0.0", "x-build-id": "gEa7mJeFjvogPcqnP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgendata~rednote-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgendata-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/nexgendata~rednote-scraper/runs": { "post": { "operationId": "runs-sync-nexgendata-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/nexgendata~rednote-scraper/run-sync": { "post": { "operationId": "run-sync-nexgendata-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": "Scrape mode", "enum": [ "trending", "keyword_search", "hashtag", "user_posts" ], "type": "string", "description": "What to scrape. 'trending' pulls the homepage discovery feed (no other inputs needed). 'keyword_search' searches RedNote for the keywords in the 'keywords' field (Chinese or English). 'hashtag' pulls posts under the hashtag/topic pages in 'hashtags'. 'user_posts' pulls recent posts from each user reference in 'users' (accepts full URL, /user/profile/{id}, or bare user id).", "default": "trending" }, "keywords": { "title": "Keywords (keyword_search mode)", "type": "array", "description": "List of search terms for 'keyword_search' mode. Chinese characters give native-quality hits (e.g. ['口红', '护肤', '穿搭']); English fall-backs work too (e.g. ['lipstick', 'skincare', 'outfit']). Ignored in other modes.", "default": [ "护肤", "口红", "穿搭" ], "items": { "type": "string" } }, "hashtags": { "title": "Hashtags / topics (hashtag mode)", "type": "array", "description": "List of RedNote hashtags or topic slugs to pull posts for, in 'hashtag' mode. Provide the tag text without the leading '#' (e.g. ['秋冬穿搭', '咖啡探店']). Falls back to keyword search if the topic page is unavailable. Ignored in other modes.", "default": [ "秋冬穿搭" ], "items": { "type": "string" } }, "users": { "title": "User references (user_posts mode)", "type": "array", "description": "List of RedNote user references for 'user_posts' mode. Accepts a full profile URL (https://www.xiaohongshu.com/user/profile/{id}), a path (/user/profile/{id}), or just the bare user id. Ignored in other modes.", "default": [], "items": { "type": "string" } }, "limit": { "title": "Max records", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of RedNote posts to return per run (across all keywords / hashtags / users). 10-30 is appropriate for daily monitoring; 100+ for one-off research sweeps.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy configuration. RESIDENTIAL is strongly recommended — RedNote is hosted in mainland China and applies anti-bot detection on datacenter IPs (returns 403/461 or empty feeds). Residential CN-egress IPs work best; the actor falls back through httpx → Playwright → maintenance stub.", "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 } } } } } } } } } }