{ "openapi": "3.0.1", "info": { "title": "RedNote (Xiaohongshu) Scraper", "description": "Scrape Xiaohongshu posts by keyword, collect comments and replies from post links, and export titles, authors, engagement, images and full details, no cookies required.", "version": "0.1", "x-build-id": "ZCRjx52giGbcyElIY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devcake~rednote-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devcake-rednote-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/devcake~rednote-scraper/runs": { "post": { "operationId": "runs-sync-devcake-rednote-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/devcake~rednote-scraper/run-sync": { "post": { "operationId": "run-sync-devcake-rednote-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 by keyword", "maxItems": 20, "type": "array", "description": "Enter one or more keywords. The sample keyword is only a starting point; each keyword gets its own result limit.", "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Choose the maximum unique notes per keyword. Start with 20 for a quick run.", "default": 20 }, "sortType": { "title": "Search order", "enum": [ "general", "popularity_descending", "time_descending" ], "type": "string", "description": "Start with this search order. Other orders may supplement results; sortSource identifies each post's discovery order.", "default": "general" }, "noteType": { "title": "Note type", "enum": [ "all", "video", "image", "live" ], "type": "string", "description": "Choose which kinds of notes to include. Live notes are filtered from all-note results.", "default": "all" }, "timeFilter": { "title": "Published within", "enum": [ "all", "1d", "1w", "6mo" ], "type": "string", "description": "Keep notes within this time window. When a source date is missing, the note ID provides the date estimate.", "default": "all" }, "includeNoteDetails": { "title": "Include full note details", "type": "boolean", "description": "Off by default. Turn on for full text, publication date, tags, gallery and video details. Each unique delivered note then adds a detail charge.", "default": false }, "noteUrls": { "title": "Post URLs", "maxItems": 20, "type": "array", "description": "Enter up to 20 Rednote post URLs or IDs to collect their comments. Clear keywords for comments-only runs, or keep keywords to run a separate search alongside comment collection.", "items": { "type": "string" } }, "maxCommentsPerNote": { "title": "Max comments per post", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Start with up to 20 top-level comments per post for a quick run. Increase the limit when needed; posts with fewer comments return fewer.", "default": 20 }, "sortBy": { "title": "Comment order", "enum": [ "recommended", "latest", "most_liked" ], "type": "string", "description": "Choose how to order comments. Newest and most liked require reading all accessible comment pages before sorting.", "default": "recommended" }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "Collect replies to each top-level comment.", "default": true }, "maxRepliesPerComment": { "title": "Max replies per comment", "minimum": 0, "maximum": 100, "type": "integer", "description": "Limit replies attached to each comment. Zero requests all accessible replies.", "default": 5 } } }, "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 } } } } } } } } } }