{ "openapi": "3.0.1", "info": { "title": "RedNote (Xiaohongshu) Creator Notes Scraper", "description": "Export recent public notes from RedNote and Xiaohongshu creator profiles with titles, note types, covers, public likes, pinned status, creator data, and note links when available. No login, browser, or residential proxy.", "version": "1.0", "x-build-id": "lGQWDN147EFlqewBM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/funny_ground~xiaohongshu-creator-notes-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-funny_ground-xiaohongshu-creator-notes-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/funny_ground~xiaohongshu-creator-notes-scraper/runs": { "post": { "operationId": "runs-sync-funny_ground-xiaohongshu-creator-notes-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/funny_ground~xiaohongshu-creator-notes-scraper/run-sync": { "post": { "operationId": "run-sync-funny_ground-xiaohongshu-creator-notes-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": [ "profileUrls" ], "properties": { "profileUrls": { "title": "Creator profiles", "minItems": 1, "maxItems": 100, "type": "array", "description": "Xiaohongshu creator profile URLs, profile share links, copied share text, or 24-character user IDs, one per line.", "items": { "type": "string" } }, "maxNotesPerProfile": { "title": "Maximum notes per creator", "minimum": 1, "maximum": 30, "type": "integer", "description": "Maximum recent note rows returned per creator. The server-rendered profile path exposes up to 30 notes in one lightweight request.", "default": 20 }, "minimumNotesPerProfile": { "title": "Minimum guaranteed notes per creator", "minimum": 1, "maximum": 30, "type": "integer", "description": "If any creator returns fewer valid notes than this value, the run fails before writing result rows. It cannot exceed the maximum above.", "default": 1 }, "failOnProfileError": { "title": "Fail if any creator misses the guarantee", "type": "boolean", "description": "Recommended. When enabled, an invalid or blocked creator fails the complete run before any result rows are written.", "default": true }, "maxConcurrency": { "title": "HTTP concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum creator profiles processed in parallel. The default balances speed and stability.", "default": 3 }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 5, "maximum": 40, "type": "integer", "description": "Timeout for each direct HTTP request.", "default": 15 }, "maxRequestRetries": { "title": "Request retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Short retries for temporary blocks or incomplete server responses.", "default": 2 } } }, "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 } } } } } } } } } }