{ "openapi": "3.0.1", "info": { "title": "RedNote Xiaohongshu Scraper: Little Red Book Notes", "description": "Get RedNote (Xiaohongshu) feed notes or full notes from share links with likes, saves, tags, creator names, images and video URLs. About $0.0049 per note: 20 notes cost $0.098. No login. Choose full details for text and counts; keyword search and comment threads are unavailable.", "version": "1.0", "x-build-id": "8v6lIUXrF6CadZIHF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/moggedhq~rednote-xiaohongshu-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-moggedhq-rednote-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/moggedhq~rednote-xiaohongshu-scraper/runs": { "post": { "operationId": "runs-sync-moggedhq-rednote-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/moggedhq~rednote-xiaohongshu-scraper/run-sync": { "post": { "operationId": "run-sync-moggedhq-rednote-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": { "channels": { "title": "Public feed channels", "type": "array", "description": "Choose recommend, food, fashion, beauty, movies, career, relationships, home, gaming, travel or fitness. Other channels can contain older selections. Leave empty when supplying only note links.", "items": { "type": "string" } }, "startUrls": { "title": "Note, creator or feed links", "type": "array", "description": "Full public note share URLs including xsec_token, creator profile links or /explore?channel_id= links. Note links always request full details. Profile metadata is free; hidden profile-grid note IDs are skipped.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum notes in this run", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Global maximum unique note rows across every input. Unavailable notes, notices, creators and summaries do not count.", "default": 20 }, "includeDetails": { "title": "Full text and engagement for feed notes", "type": "boolean", "description": "Read each note page for full text, saves, comment count, shares, tags, publish time and media. Slower: about 3 seconds per extra request. No extra note charge. OFF returns clearly labelled feed previews with title, likes, creator and cover.", "default": false }, "noteType": { "title": "Note type", "enum": [ "all", "image", "video" ], "type": "string", "description": "Filter the public sample to image or video notes.", "default": "all" }, "sort": { "title": "Sort the collected sample", "enum": [ "general", "newest", "popular" ], "type": "string", "description": "general preserves source order. newest/popular writes a free SORTED-NOTES export for the collected sample; it does not change platform search ranking. Previews have no publish time.", "default": "general" }, "includeComments": { "title": "Request comment threads (unavailable signed out)", "type": "boolean", "description": "Compatibility field. Comment threads are unavailable in this public page route. TRUE gives a free notice. Full notes include comment counts when shown.", "default": false }, "maxCommentsPerNote": { "title": "Maximum comments (compatibility only)", "minimum": 0, "type": "integer", "description": "Reserved input. This build does not retrieve comment threads and never charges for comments.", "default": 20 }, "searchTerms": { "title": "Keyword search (unavailable signed out)", "type": "array", "description": "Compatibility field. Search is unavailable signed out and produces a free notice. Choose public feed channels or supply complete note links for usable note output.", "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Default: datacenter, fresh-session retry, then China residential only after refusal. You may supply your own proxy settings. No account cookies or login tokens are accepted." } } }, "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 } } } } } } } } } }