{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu RedNote Scraper", "description": "Scrape public Xiaohongshu (RedNote) notes from note URLs or 24-character note IDs: title, description, hashtags, publish date, author, like, collect, comment and share counts, image URLs and video URL. No keyword or user search: you supply the notes. No login needed.", "version": "1.0", "x-build-id": "fKJSXQ0SxkbbVydBh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiomworks~xiaohongshu-note-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiomworks-xiaohongshu-note-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/axiomworks~xiaohongshu-note-scraper/runs": { "post": { "operationId": "runs-sync-axiomworks-xiaohongshu-note-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/axiomworks~xiaohongshu-note-scraper/run-sync": { "post": { "operationId": "run-sync-axiomworks-xiaohongshu-note-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": { "noteUrls": { "title": "Note URLs or 24-hex note IDs", "type": "array", "description": "Public Xiaohongshu notes to scrape, as full URLs or bare 24-hex IDs, e.g. [\"https://www.xiaohongshu.com/explore/68c8d6d7000000001d01bdbd\", \"68c8d6d7000000001d01bdbd\"]. Also accepts /discovery/item/ and profile-style note URLs; keep xsec_token if present. xhslink.com short links are not resolved. Dead or blocked notes are skipped with no row. Leave empty only with discoverFromSitemap=true.", "items": { "type": "string" } }, "discoverFromSitemap": { "title": "Sample notes from public sitemap", "type": "boolean", "description": "Set true to read a fixed public sitemap sample when noteUrls is empty, e.g. {\"discoverFromSitemap\":true,\"maxItems\":1}. Default false. Supplied note URLs take priority. This does not search keywords, authors or dates.", "default": false }, "maxItems": { "title": "Max notes to return (1-10000)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum notes to return across ALL noteUrls combined (shared budget), 1-10000, default 20; e.g. 3 returns the first 3 notes that load. Dead, blocked and noteType-filtered notes are skipped, uncharged and do not count, so fewer rows are possible.", "default": 20 }, "includeRawCounts": { "title": "Add raw display counts", "type": "boolean", "description": "Set true to include rawCounts with original displayed likes, saves, comments and shares, e.g. \"1.2δΈ‡\", alongside parsed numbers. Default false; rawCounts is null when disabled.", "default": false }, "proxyConfiguration": { "title": "Proxy settings for public note requests", "type": "object", "description": "Apify Proxy settings, e.g. {\"useApifyProxy\":true} (the prefill; recommended on Apify). Failed or blocked requests retry on a fresh session; with no groups chosen the Actor falls back to residential proxy. Locally, leave off." }, "noteType": { "title": "Note type to return", "enum": [ "all", "normal", "video" ], "type": "string", "description": "Return all public notes by default, or only normal (image/text) or video notes. Filtering happens after fetching; skipped types are not charged or counted toward the shared maxItems limit. Sitemap discovery inspects at most maxItems candidate IDs, so a filter may return fewer rows.", "default": "all" } } }, "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 } } } } } } } } } }