{ "openapi": "3.0.1", "info": { "title": "RedNote Xiaohongshu Scraper — Notes & Profiles", "description": "Scrape public RedNote (Xiaohongshu) Explore feeds, note details, creator profiles, engagement, images, video metadata, and monitoring-ready change records—without supplying an account or cookies.", "version": "0.0", "x-build-id": "sQIqMRg6I8GLnes9b" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapingmonkey~rednote-xiaohongshu-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapingmonkey-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/scrapingmonkey~rednote-xiaohongshu-scraper/runs": { "post": { "operationId": "runs-sync-scrapingmonkey-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/scrapingmonkey~rednote-xiaohongshu-scraper/run-sync": { "post": { "operationId": "run-sync-scrapingmonkey-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", "required": [ "mode" ], "properties": { "mode": { "title": "Scraping mode", "enum": [ "auto", "explore", "noteDetails", "profiles", "monitor" ], "type": "string", "description": "Choose public explore, note, profile, automatic URL detection, or recurring monitoring.", "default": "explore" }, "channelIds": { "title": "Explore channel IDs", "type": "array", "description": "Public RedNote explore channel identifiers.", "items": { "type": "string" }, "default": [ "homefeed_recommend" ] }, "noteUrls": { "title": "Note URLs", "type": "array", "description": "Full public RedNote note URLs, including their current xsec_token when required by the page.", "items": { "type": "string" }, "default": [] }, "profileUrls": { "title": "Profile URLs", "type": "array", "description": "Full public RedNote profile URLs, including their current xsec_token when required by the page.", "items": { "type": "string" }, "default": [] }, "startUrls": { "title": "RedNote URLs", "type": "array", "description": "Public note or profile URLs for auto mode.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Maximum items per result family", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum feed, note, and profile rows retained per result family.", "default": 50 }, "includeNoteDetails": { "title": "Enrich note details", "type": "boolean", "description": "Load every accessible feed item's public note page with an additional HTTP request.", "default": true }, "includeProfiles": { "title": "Enrich profiles", "type": "boolean", "description": "Load accessible public author profile pages discovered in the feed.", "default": false }, "language": { "title": "Page language", "type": "string", "description": "Accept-Language locale sent to RedNote, for example zh-CN or en-US.", "default": "zh-CN" }, "maxConcurrency": { "title": "Maximum HTTP concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Maximum targets or enrichments processed at once.", "default": 2 }, "country": { "title": "Country / region", "type": "string", "description": "Two-letter ISO country used as the public request region.", "default": "US" }, "includeRaw": { "title": "Include redacted raw objects", "type": "boolean", "description": "Add the complete public source object after cookie, authorization, token, and signature fields are redacted. Increases dataset size.", "default": false }, "monitorMode": { "title": "Change monitoring", "enum": [ "off", "onlyNew", "newAndChanged" ], "type": "string", "description": "Optionally save only new records or new and changed records between named runs.", "default": "off" }, "monitorKey": { "title": "Monitor key", "type": "string", "description": "Stable namespace for comparison state. Use a different key for independent monitors.", "default": "default" }, "maxSessionRotations": { "title": "Session rotations", "minimum": 1, "maximum": 6, "type": "integer", "description": "Maximum fresh residential proxy sessions tried after blocks, limits, or challenges.", "default": 3 }, "requestTimeoutSecs": { "title": "HTTP request timeout", "minimum": 15, "maximum": 120, "type": "integer", "description": "Maximum time in seconds for one public HTTP request.", "default": 45 } } }, "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 } } }, "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 } } } } } } } } } }