{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu (RedNote / 小红书) Creator & KOL Leads Scraper", "description": "⚡ Fast & Cheap ($3.50/1k): Monitor & scrape RedNote (小红书) user profiles, KOL leads, follower stats & note portfolios. Auto-discover creators from trending feeds & live streams, zero cookies.", "version": "1.0", "x-build-id": "tMvz4I8GsODWVSVmz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/unitbytes~xiaohongshu-rednote-profile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-unitbytes-xiaohongshu-rednote-profile-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-rednote-profile-scraper/runs": { "post": { "operationId": "runs-sync-unitbytes-xiaohongshu-rednote-profile-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-rednote-profile-scraper/run-sync": { "post": { "operationId": "run-sync-unitbytes-xiaohongshu-rednote-profile-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": [ "creatorLeads", "creators" ], "type": "string", "description": "Choose whether to auto-discover KOL leads from category feeds, or scrape specific creators. Tip: If you paste Creator URLs or User IDs below, it automatically scrapes those creators even if you leave this dropdown unchanged.", "default": "creatorLeads" }, "channels": { "title": "Discover Creators From Category Feeds", "type": "array", "description": "Select Xiaohongshu categories to discover active creators from.", "items": { "type": "string", "enum": [ "homefeed_recommend", "homefeed.fashion_v3", "homefeed.cosmetics_v3", "homefeed.food_v3", "homefeed.travel_v3", "homefeed.fitness_v3", "homefeed.household_product_v3", "homefeed.baby_v3", "homefeed.tech_v3", "homefeed.gaming_v3", "homefeed.career_v3", "homefeed.love_v3", "homefeed.movies_and_tv_v3" ], "enumTitles": [ "✨ Recommended (推荐)", "👗 Fashion & OOTD (穿搭)", "💄 Beauty & Cosmetics (彩妆护肤)", "🍜 Food & Dining (美食)", "✈️ Travel (旅行)", "💪 Fitness (健身)", "🏠 Home & Living (家居)", "👶 Parenting & Baby (母婴)", "📱 Tech & Digital (科技数码)", "🎮 Gaming (游戏)", "💼 Career (职场)", "💕 Relationships (情感)", "🎬 Movies & TV (影视)" ] } }, "includeLiveHosts": { "title": "Also Include Active Live Stream Hosts in Lead Discovery", "type": "boolean", "description": "When enabled in KOL Lead Discovery mode, also discovers active live stream hosts alongside category creators.", "default": true }, "creatorUrls": { "title": "Direct Creator Profile URLs, 24-Char User IDs, or Note Links", "type": "array", "description": "Paste Xiaohongshu profile URLs (https://www.xiaohongshu.com/user/profile/...), 24-character hex User IDs (e.g. 55a1ffc867bc65487fdf2943), or Note Share Links to extract the author's profile.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxCreators": { "title": "Max Creators", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of unique creator profiles to extract.", "default": 10 }, "scrapePortfolio": { "title": "Extract Creator's Recent Portfolio Notes", "type": "boolean", "description": "Extract the creator's recent published notes (up to ~30 recent notes via public SSR). Note: In KOL Lead Discovery mode, defaults to fast profile-only extraction unless you also customize 'Max Recent Notes Per Creator' below.", "default": true }, "maxNotesPerCreator": { "title": "Max Recent Notes Per Creator", "minimum": 1, "maximum": 35, "type": "integer", "description": "Maximum number of recent portfolio notes to extract per creator (public SSR provides up to ~30 recent notes per profile).", "default": 15 }, "enrichNoteDetails": { "title": "Enrich Portfolio Notes with Full Text & HD Media", "type": "boolean", "description": "Fetch full note text, tags, and HD media for portfolio notes when an xsec_token is available.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Xiaohongshu requires Residential proxies (Hong Kong recommended).", "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 } } } } } } } } } }