{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu Scraper", "description": "Paste Xiaohongshu note links, or leave them empty to read the public feed, and get rows with title, body text, author, publish date, hashtags, image count and all four engagement counters: likes, comments, collects and shares. No account, no keyword search.", "version": "0.1", "x-build-id": "YNKS24cLxK9ebcf56" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~xiaohongshu-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-xiaohongshu-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/s-r~xiaohongshu-scraper/runs": { "post": { "operationId": "runs-sync-s-r-xiaohongshu-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/s-r~xiaohongshu-scraper/run-sync": { "post": { "operationId": "run-sync-s-r-xiaohongshu-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 links", "type": "array", "description": "Xiaohongshu note links, one per line. Paste the link exactly as you copied it from the app or the browser address bar: the xsec_token in the link is what makes the note readable, and a link stripped back to just the note id returns nothing. Leave this empty to read the public recommendation feed instead.", "items": { "type": "string" } }, "xsecToken": { "title": "Token for bare note ids", "type": "string", "description": "Only needed if you are supplying note ids without their links. A token belongs to one note, so this single value is applied to every id in the list and will only work for the note it came from. Paste full links instead wherever you can." }, "feedCategory": { "title": "Feed category", "enum": [ "recommended", "fashion", "food", "cosmetics", "movies", "career", "relationships", "home", "gaming", "travel", "fitness", "video" ], "type": "string", "description": "Which slice of the public recommendation feed to read when no note links are supplied. Ignored when you paste links.", "default": "recommended" }, "maxItems": { "title": "Maximum notes", "minimum": 1, "maximum": 2000, "type": "integer", "description": "How many notes to return in total. Pasted links are read first. Feed runs return roughly thirty notes per load and the feed is metered, so a feed-only run realistically returns around a hundred and fifty before it has to wait; the run summary reports it when that happens.", "default": 50 }, "includeNoteDetail": { "title": "Fetch full note detail", "type": "boolean", "description": "On, the Actor opens every note for its description, hashtags, image list, publish date and all four engagement counters. Off, it returns only what the feed card carries: id, title, author, cover image and like count, at one request instead of two. Pasted links need this on, because a link on its own carries no data.", "default": true }, "includeImages": { "title": "Include image URLs", "type": "boolean", "description": "Add the full list of image links to every row. The image count is always returned; this adds the addresses themselves, which makes the dataset considerably wider on photo notes.", "default": false }, "noteType": { "title": "Note type", "enum": [ "any", "normal", "video" ], "type": "string", "description": "Keep only photo notes or only video notes. Applied after the notes are read, so it narrows the output rather than the work.", "default": "any" }, "minLikes": { "title": "Minimum likes", "minimum": 0, "type": "integer", "description": "Drop notes below this like count. Zero keeps everything. Applied after the notes are read.", "default": 0 } } }, "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 } } } } } } } } } }