{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu Note Comments Scraper", "description": "Fetch the public comment list for a Xiaohongshu note by note_id or share_text. Supports pagination (page 1-10) with cursor + index + pageArea tokens and three sort strategies.", "version": "0.7", "x-build-id": "9ZGXtE0taoI0RN1RM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/opspilot.cc~xiaohongshu-note-comments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-opspilot.cc-xiaohongshu-note-comments-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/opspilot.cc~xiaohongshu-note-comments-scraper/runs": { "post": { "operationId": "runs-sync-opspilot.cc-xiaohongshu-note-comments-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/opspilot.cc~xiaohongshu-note-comments-scraper/run-sync": { "post": { "operationId": "run-sync-opspilot.cc-xiaohongshu-note-comments-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": [ "page", "cursor", "index", "pageArea", "sort_strategy" ], "properties": { "note_id": { "title": "Note ID", "maxLength": 64, "type": "string", "description": "Xiaohongshu note ID, for example: 697c0eee000000000a03c308. Preferred over share_text. If both are provided, note_id wins. Default value is used when the Actor is invoked with empty input so Apify automated tests can run without manual setup.", "default": "697c0eee000000000a03c308" }, "share_text": { "title": "Share text", "maxLength": 2000, "type": "string", "description": "Paste a Xiaohongshu share link or the full share text from the app. The Actor extracts the first http(s) URL automatically. Use this only when you do not have a raw note_id.", "default": "" }, "page": { "title": "Page number", "minimum": 1, "maximum": 10, "type": "integer", "description": "Page number, start from 1. The Actor calls upstream once per page, so page=3 makes 3 upstream requests. The default of 1 keeps every run cheap.", "default": 1 }, "cursor": { "title": "Cursor (for pagination)", "type": "string", "description": "Required when page >= 2. Copy from the previous run SUMMARY field `nextCursor` (or the first item's `rawData.cursor`). Leave blank for page = 1.", "default": "" }, "index": { "title": "Index (for pagination)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Required when page >= 2. Comment index from the previous run, e.g. the SUMMARY `nextIndex` or first item's `rawData.index`. Use 0 for the first page.", "default": 0 }, "pageArea": { "title": "Page area (for pagination)", "enum": [ "UNFOLDED", "FOLDED" ], "type": "string", "description": "Required when page >= 2. Fold status from the previous run. Use `UNFOLDED` (expanded, the default) for the first page.", "default": "UNFOLDED" }, "sort_strategy": { "title": "Sort strategy", "enum": [ "latest_v2", "like_count", "default" ], "type": "string", "description": "How comments are ranked. `latest_v2` is the recommended default — time desc with stable pagination. `default` is not recommended because paginating may cause missing or duplicate comments.", "default": "latest_v2" } } }, "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 } } } } } } } } } }