{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu (RedNote) All-in-One Scraper 小红书 [From $2] No Login", "description": "[From $2 per 1000 results] Xiaohongshu / RedNote / Little Red Book (小红书, XHS) scraper with no login, cookie or xsec_token. Search notes, full notes with video files, all comments and replies, creators, creator search, topics, products with reviews and hot topics. Notes $3, comments $4 per 1,000.", "version": "0.1", "x-build-id": "lJj5bcMZncFvVtcUH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~xiaohongshu-all-in-one-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-xiaohongshu-all-in-one-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/memo23~xiaohongshu-all-in-one-scraper/runs": { "post": { "operationId": "runs-sync-memo23-xiaohongshu-all-in-one-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/memo23~xiaohongshu-all-in-one-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-xiaohongshu-all-in-one-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": { "keywords": { "title": "Search keywords", "type": "array", "description": "Search Xiaohongshu notes by keyword, in Chinese or English. Each keyword is searched on its own; a page holds 20 notes.", "items": { "type": "string" } }, "maxResultsPerKeyword": { "title": "Max notes per keyword", "minimum": 5, "maximum": 100000, "type": "integer", "description": "How many notes to return for each keyword (minimum 5).", "default": 40 }, "searchSort": { "title": "Sort search by", "enum": [ "general", "latest", "mostLiked", "mostCommented", "mostSaved" ], "type": "string", "description": "Order of the search results.", "default": "general" }, "searchNoteType": { "title": "Note type", "enum": [ "all", "video", "image" ], "type": "string", "description": "Return all notes, only video notes or only image notes.", "default": "all" }, "searchTime": { "title": "Published within", "enum": [ "all", "day", "week", "halfYear" ], "type": "string", "description": "Limit the search to recent notes.", "default": "all" }, "noteUrls": { "title": "Note links or IDs", "type": "array", "description": "Note links (xiaohongshu.com/explore/…, /discovery/item/…), xhslink.com share links, or 24-character note IDs. Each returns the full note: text, hashtags, images or the video file, counts and IP location. No xsec_token needed.", "items": { "type": "string" } }, "includeNoteDetails": { "title": "Open every found note for full details", "type": "boolean", "description": "Search, creator, topic and feed lists already return text, counts and images. Turn this on to also open each note for its hashtags with topic IDs, IP location, share count and, for video notes, the video file and subtitles. Each opened note is billed as a note detail instead of a note.", "default": false }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Return the comments of every note in the run as separate rows. Notes known to have fewer than 3 comments are skipped.", "default": false }, "maxCommentsPerNote": { "title": "Max comments per note", "minimum": 5, "maximum": 100000, "type": "integer", "description": "Top-level comments to return for each note (minimum 5). A page holds 10 to 15.", "default": 20 }, "commentSort": { "title": "Sort comments by", "enum": [ "latest", "mostLiked" ], "type": "string", "description": "Order of the comments. On some notes Xiaohongshu ends an order early; the run then carries on in its own order, skipping comments already returned, so you still get the whole thread.", "default": "latest" }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "Also return the replies under each comment. The reply shown under a comment always comes along; longer reply threads are opened when a comment has 5 or more replies.", "default": false }, "maxRepliesPerComment": { "title": "Max replies per comment", "minimum": 5, "maximum": 100000, "type": "integer", "description": "Replies to return for each comment (minimum 5).", "default": 10 }, "creators": { "title": "Creator profile links or user IDs", "type": "array", "description": "Profile links (xiaohongshu.com/user/profile/…), xhslink.com share links or 24-character user IDs. Each returns the profile: followers, following, note count, likes and saves received, bio, location and verification.", "items": { "type": "string" } }, "includeCreatorNotes": { "title": "Include the creator's notes", "type": "boolean", "description": "Also return the notes each creator has posted, newest first.", "default": true }, "maxNotesPerCreator": { "title": "Max notes per creator", "minimum": 5, "maximum": 100000, "type": "integer", "description": "Notes to return for each creator (minimum 5). A page holds 20.", "default": 20 }, "creatorKeywords": { "title": "Creator search keywords", "type": "array", "description": "Find creators by name or keyword. Returns name, RED ID, follower count and verification. Works without login.", "items": { "type": "string" } }, "maxCreatorsPerKeyword": { "title": "Max creators per keyword", "minimum": 5, "maximum": 100000, "type": "integer", "description": "Creators to return for each keyword (minimum 5). A page holds 20.", "default": 20 }, "topics": { "title": "Topic links or topic IDs", "type": "array", "description": "Topic (hashtag) page IDs or topic links. Note rows carry the IDs of their topics in `topicIds`, so a first run can feed a second. Each topic returns its view and note counts plus its notes.", "items": { "type": "string" } }, "maxResultsPerTopic": { "title": "Max notes per topic", "minimum": 5, "maximum": 100000, "type": "integer", "description": "Notes to return for each topic (minimum 5). A page holds 10.", "default": 30 }, "topicSort": { "title": "Sort topic notes by", "enum": [ "trending", "latest" ], "type": "string", "description": "Order of a topic's notes.", "default": "trending" }, "productKeywords": { "title": "Product search keywords", "type": "array", "description": "Search the Xiaohongshu shop by keyword. Returns title, price, original price, units sold, promotion and shop.", "items": { "type": "string" } }, "maxProductsPerKeyword": { "title": "Max products per keyword", "minimum": 5, "maximum": 100000, "type": "integer", "description": "Products to return for each keyword (minimum 5). A page holds 20.", "default": 20 }, "products": { "title": "Product links or IDs", "type": "array", "description": "Product links (…/goods-detail/…) or 24-character product IDs, as returned by product search. Each returns the product page: price, images, attributes, rating with its breakdown, and the shop with its scores.", "items": { "type": "string" } }, "includeReviews": { "title": "Include buyer reviews", "type": "boolean", "description": "Return buyer reviews of each product given by link or ID: text, star ratings, tags, photos and the variant bought. Also adds each product's star-rating breakdown and purchase count.", "default": false }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 5, "maximum": 100000, "type": "integer", "description": "Reviews to return for each product (minimum 5). A page holds 12.", "default": 24 }, "reviewSort": { "title": "Sort reviews by", "enum": [ "default", "latest" ], "type": "string", "description": "Order of the reviews.", "default": "default" }, "imageKeywords": { "title": "Image search keywords", "type": "array", "description": "Search single images by keyword. Each row is one image with the note it belongs to.", "items": { "type": "string" } }, "maxImagesPerKeyword": { "title": "Max images per keyword", "minimum": 5, "maximum": 100000, "type": "integer", "description": "Images to return for each keyword (minimum 5). A page holds 20.", "default": 20 }, "groupKeywords": { "title": "Group chat search keywords", "type": "array", "description": "Find public group chats by keyword: name, description, member count and recent activity. Up to 20 per keyword.", "items": { "type": "string" } }, "suggestKeywords": { "title": "Keywords for search suggestions", "type": "array", "description": "Return the search suggestions Xiaohongshu shows while typing each keyword, about 10 per keyword.", "items": { "type": "string" } }, "includeHotTopics": { "title": "Hot topics list", "type": "boolean", "description": "Return the live hot list: trending events with the number of people viewing each.", "default": false }, "includeTrendingTopics": { "title": "Trending posting topics", "type": "boolean", "description": "Return the topics Xiaohongshu suggests to creators, each with the number of notes posted under it.", "default": false }, "maxTopicsPerList": { "title": "Max rows per topic list", "minimum": 5, "maximum": 100000, "type": "integer", "description": "Rows to return from each topic list (minimum 5).", "default": 20 }, "feedCategories": { "title": "Explore feed categories", "type": "array", "description": "Return notes from the explore feed of the chosen categories. Feed rows carry title, cover, likes and author; turn on full details for the rest.", "items": { "type": "string", "enum": [ "recommend", "fashion", "food", "cosmetics", "movie_and_tv", "kpop", "career", "love", "household_product", "gaming", "travel", "fitness", "video" ], "enumTitles": [ "Recommended", "Fashion 穿搭", "Food 美食", "Makeup 彩妆", "Film & TV 影视", "K-pop", "Career 职场", "Relationships 情感", "Home 家居", "Gaming 游戏", "Travel 旅行", "Fitness 健身", "Video 视频" ] } }, "maxResultsPerFeed": { "title": "Max notes per feed category", "minimum": 5, "maximum": 100000, "type": "integer", "description": "Notes to return for each feed category (minimum 5). A page holds 20.", "default": 20 }, "maxItems": { "title": "Max notes per run", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Upper limit on note rows across the whole run. Free-plan accounts get up to 100.", "default": 200 } } }, "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 } } } } } } } } } }