{ "openapi": "3.0.1", "info": { "title": "RedNote (Xiaohongshu / 小红书) Scraper: Posts, Trends & Creators", "description": "⚡Ultra Fast & Cheapest all-in-one Xiaohongshu (RedNote / 小红书 / XHS) scraper. Extract viral posts, search results, category trends, HD media & complete influencer intelligence in seconds. Zero cookies required.", "version": "2.0", "x-build-id": "OQp0Jc5IAhCf7dlgH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/unitbytes~xiaohongshu-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-unitbytes-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/unitbytes~xiaohongshu-scraper/runs": { "post": { "operationId": "runs-sync-unitbytes-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/unitbytes~xiaohongshu-scraper/run-sync": { "post": { "operationId": "run-sync-unitbytes-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": { "startUrls": { "title": "Start URLs (Search, Category, Note, or Creator Links)", "type": "array", "description": "Universal input: paste Xiaohongshu/RedNote search URLs ('search_result?keyword=...'), trending feeds, direct post links ('explore/...'), or creator profile links ('user/profile/...').", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "keywords": { "title": "Search Keywords", "type": "array", "description": "Keywords in Chinese, English, Pinyin, or hashtags (e.g. 'OOTD', '护肤', 'skincare', '秋季穿搭', '美食').", "items": { "type": "string" } }, "trendingChannel": { "title": "Explore Trending Category", "enum": [ "none", "homefeed_recommend", "homefeed.fashion_v3", "homefeed.cosmetics_v3", "homefeed.food_v3", "homefeed.travel_v3", "homefeed.household_product_v3", "homefeed.gaming_v3", "homefeed.fitness_v3", "homefeed.movie_and_tv_v3", "homefeed.career_v3", "homefeed.love_v3", "homefeed.pet", "homefeed.video_v3" ], "type": "string", "description": "Scrape official real-time trending feeds by category without requiring login or user credentials.", "default": "none" }, "sort": { "title": "Sort By", "enum": [ "popularity_descending", "time_descending", "general" ], "type": "string", "description": "Ranking order for note discovery.", "default": "popularity_descending" }, "noteType": { "title": "Note Format Filter", "enum": [ "all", "video_only", "image_only" ], "type": "string", "description": "Filter by media format.", "default": "all" }, "deepCreatorAudit": { "title": "⚡ Deep Influencer Discovery & Audit (Composite Mode)", "type": "boolean", "description": "SUPERPOWER: Automatically audits the creators behind top viral posts! Searches your keyword or category, extracts author profile links, and scrapes their follower counts, verification badges, bio, and engagement metrics.", "default": false }, "creatorUrls": { "title": "Creator Profile URLs or Share Links", "type": "array", "description": "Direct Xiaohongshu creator profile URLs (e.g. 'https://www.xiaohongshu.com/user/profile/5b331070e8cd614138e4a9e5?xsec_token=...') or mobile share links ('xhslink.com/...').", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "userIds": { "title": "Creator User IDs", "type": "array", "description": "Direct 24-character hexadecimal Xiaohongshu user IDs (e.g. '5b331070e8cd614138e4a9e5'). Extracts full creator profile intelligence (stats, bio, verification).", "items": { "type": "string" } }, "redIds": { "title": "Xiaohongshu Red IDs / Handles", "type": "array", "description": "Xiaohongshu Red IDs / handles (e.g. '88888888', 'fashion_daily'). Matched and verified against creator profiles.", "items": { "type": "string" } }, "maxCreators": { "title": "Max Creators to Process", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of creators to enrich across all targets or in composite discovery (1 to 100).", "default": 10 }, "maxNotesPerCreator": { "title": "Max Notes Per Creator", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum number of notes to scrape per creator (0 to 1,000). Set to 0 to extract Creator Profile Intelligence only.", "default": 30 }, "scrapePortfolio": { "title": "Extract Published Note Portfolio", "type": "boolean", "description": "When enabled, paginates through the creator's published notes to extract complete portfolio metrics and engagement.", "default": true }, "enrichNoteDetails": { "title": "Enrich Full Note Details & HD Media", "type": "boolean", "description": "When enabled, fetches full post body, hashtags, uncompressed HD gallery images, and watermark-free video download link.", "default": true }, "maxItems": { "title": "Max Items (Total)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum total items (posts and profiles) to scrape across the run.", "default": 30 }, "resumptionToken": { "title": "Resumption Token (Optional)", "type": "string", "description": "Optional enterprise resumption token copied from a previous run's pagination metadata to resume with exact session continuity." }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Leave as is to use the built-in Apify Residential proxy in Hong Kong (strictly recommended for Xiaohongshu anti-bot). You can also enter your own residential proxy URLs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "HK" } } } }, "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 } } } } } } } } } }