{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu Scraper | XHS RedNote Notes & Trends", "description": "Collect public Xiaohongshu / XHS / RedNote note details, photo and video links, and topic snapshots. Export JSON, CSV or Excel. No XHS login or customer API key. Limited public coverage.", "version": "0.23", "x-build-id": "9t70LCFeiwpQmGXIx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apivault_labs~xhs-notes-collector/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apivault_labs-xhs-notes-collector", "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/apivault_labs~xhs-notes-collector/runs": { "post": { "operationId": "runs-sync-apivault_labs-xhs-notes-collector", "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/apivault_labs~xhs-notes-collector/run-sync": { "post": { "operationId": "run-sync-apivault_labs-xhs-notes-collector", "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": "What to collect", "enum": [ "notes", "trends" ], "type": "string", "description": "Choose notes for supplied public post links, or trends for a topic snapshot without links. No keyword search, creator profiles or comment-text collection. Topic freshness is unverified.", "default": "notes" }, "noteUrls": { "title": "Xiaohongshu / RedNote links", "type": "array", "description": "For notes mode: paste public note links, short share links, or copied share text containing one link per entry. Maximum 100 entries. No account cookies needed.", "items": { "type": "string" } }, "includeAvailableMetrics": { "title": "Include available note metrics", "type": "boolean", "description": "Notes only. Enable to try additional counters and publication date; select basic or extended with metricsLevel. Uses an extra request per note within maxRequests. Unknown values remain null.", "default": false }, "max_items": { "title": "Maximum results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum records to return. Topic rows and note rows are different record types.", "default": 20 }, "maxRequests": { "title": "Maximum requests", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Limit network work for this run, including failed attempts and share-link resolution. Reaching the limit can leave unfinished links.", "default": 100 }, "requestDelaySeconds": { "title": "Delay between requests", "minimum": 0, "maximum": 60, "type": "number", "description": "Seconds to wait between network requests. Does not guarantee access or successful collection.", "default": 1 }, "publishedAfter": { "title": "Notes published after", "type": "string", "description": "Optional timezone-aware ISO timestamp for notes only. Records with unknown publication dates are excluded; use available metrics if needed." }, "dedupState": { "title": "Previously collected record IDs", "type": "object", "description": "Optional DEDUP_STATE from a previous run to skip already returned records. Use a separate history for each collection mode." }, "page_offset": { "title": "Saved result position", "minimum": 0, "maximum": 100000, "type": "integer", "description": "For continuing a limited run: use the value from CHECKPOINTS together with its saved page hash.", "default": 0 }, "resume_page_hash": { "title": "Saved result fingerprint", "type": "string", "description": "Copy from CHECKPOINTS when continuing a limited run. Changed results stop safely instead of reusing an outdated position." }, "resumeRecordKeys": { "title": "Saved IDs from the current result", "type": "array", "description": "Copy from CHECKPOINTS with a saved position to avoid duplicates when continuing a limited run.", "items": { "type": "string" } }, "maxSeenRecords": { "title": "Maximum saved record IDs", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum record IDs kept for duplicate prevention. A full history stops collection without losing the saved position.", "default": 10000 }, "metricsLevel": { "title": "Available metrics level", "enum": [ "basic", "extended" ], "type": "string", "description": "Notes only; requires includeAvailableMetrics=true. Basic tries likes and publication date. Extended also tries save, comment and share counts. Unknown counts are null, not zero. No comment text.", "default": "basic" } } }, "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 } } } } } } } } } }