{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu (RedNote / 小红书) Live Stream & Commerce Scraper", "description": "The fastest Xiaohongshu (RedNote / 小红书 / XHS) Live Stream & Live Commerce scraper. Extract active live rooms across all 7 live categories, 1080p FLV & HLS (.m3u8) stream URLs, concurrent viewers, e-commerce goods flags, real-time live chat, and host KOL profiles.", "version": "1.0", "x-build-id": "bAXaYO4GSXDL1wfiW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/unitbytes~xiaohongshu-rednote-live-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-unitbytes-xiaohongshu-rednote-live-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-live-scraper/runs": { "post": { "operationId": "runs-sync-unitbytes-xiaohongshu-rednote-live-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-live-scraper/run-sync": { "post": { "operationId": "run-sync-unitbytes-xiaohongshu-rednote-live-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": "Scraping Mode", "enum": [ "live", "liveChat" ], "type": "string", "description": "live = scrape active Xiaohongshu Live Stream rooms (with 1080p .flv & .m3u8 video stream URLs, concurrent viewers, e-commerce goods status, embedded chat, and host KOL profiles). liveChat = extract standalone real-time live chat messages, fan-club badges & buyer intent keywords across active rooms.", "default": "live" }, "liveCategories": { "title": "Live Stream Categories", "type": "array", "description": "Select which Xiaohongshu Live channels (/livelist) to sweep for active live broadcasts, e-commerce hosts (hasGoods), 1080p video streams, and live chat.", "items": { "type": "string", "enum": [ "0", "1", "2", "3", "4", "5", "6" ], "enumTitles": [ "All Live Streams (全部 / All)", "Gaming (游戏)", "Talent & Beauty (才艺颜值)", "Lifestyle (生活分享)", "Crafts & Hobbies (兴趣手工)", "Tech & Finance (科技财经)", "Sports & Outdoors (运动户外)" ] } }, "startUrls": { "title": "Direct Live List or Room URLs", "type": "array", "description": "Optional: paste Xiaohongshu live URLs such as 'https://www.xiaohongshu.com/livelist?channel_id=0&channel_type=web_live_list', room URLs with 'room_id=...', or bare 18-19 digit numeric room IDs. Leave empty to sweep the selected Live Stream Categories above.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max Live Rooms (or Max Chat Messages in LiveChat Mode)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of live stream rooms (or standalone chat messages when Mode = Live Chat) to extract. Supports multi-page cursor pagination across active broadcasts.", "default": 27 }, "includeLiveChat": { "title": "Include Real-Time Live Chat & Buyer Intent Keywords", "type": "boolean", "description": "When enabled, queries each live room's real-time chat feed to attach active viewer messages, fan-club badges (fansGroup), and buyer intent keywords.", "default": true }, "includeAuthorProfile": { "title": "Enrich Host KOL Profile (Followers, Likes & Red ID)", "type": "boolean", "description": "When enabled, enriches each live broadcaster's author object with their full KOL profile metrics (followerCount, followerCountFormatted, totalLikesAndCollects, redId, bio, verification).", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Pre-configured with Apify Residential (Hong Kong) for reliable access.", "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 } } } } } } } } } }