{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu (RedNote) User Profile & Notes Scraper", "description": "Extract any Xiaohongshu (RedNote) creator's full profile and every note they posted: nickname, bio, follower counts, IP city, verification, plus per-note likes, collects, comments, images and video URLs. Paste profile URLs or user IDs. 68 profile fields, export to JSON, CSV, or Excel.", "version": "0.0", "x-build-id": "kbHjgNJrtzbeSoxl5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zen-studio~rednote-user-profile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zen-studio-rednote-user-profile-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/zen-studio~rednote-user-profile-scraper/runs": { "post": { "operationId": "runs-sync-zen-studio-rednote-user-profile-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/zen-studio~rednote-user-profile-scraper/run-sync": { "post": { "operationId": "run-sync-zen-studio-rednote-user-profile-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": [ "profileUrls" ], "properties": { "profileUrls": { "title": "πŸ‘€ Profile URLs, post links, share links, or user IDs", "minItems": 1, "type": "array", "description": "Add one or more Xiaohongshu user references. Five formats accepted:

β€’ Profile URL: https://www.xiaohongshu.com/user/profile/65c381340000000011014d37
β€’ Bare 24-char user ID: 65c381340000000011014d37
β€’ Share link, or the whole copied message: https://xhslink.com/m/Ap1vXtgAixh (auto-resolved)
β€’ RedNote ID (小纒书号): numeric like 95690072122 or alphanumeric like Patellana
β€’ Post link: https://www.xiaohongshu.com/explore/6a173b10000000000803cefa β€” resolves to the post's author and scrapes their profile

Each profile runs independently with its own Max notes per profile budget.", "items": { "type": "string" } }, "includeNotes": { "title": "πŸ“ Include notes", "type": "boolean", "description": "When ON (default), the output includes the creator's notes (capped by Max notes per profile).

Turn OFF to fetch the profile only and skip note collection entirely. This is the fastest, cheapest option for bulk profile or metadata lookups: you pay just the per-profile rate, with no note charges.", "default": true }, "maxNotesPerProfile": { "title": "πŸ“Š Max notes per profile", "minimum": 0, "maximum": 10000, "type": "integer", "description": "How many notes to collect per profile. Set to 0 to fetch every note the user has posted.

Notes are returned in the order Xiaohongshu serves them (typically newest first, with pinned notes near the top). Each note counts as one billable result, so this is the lever for prolific creators with hundreds of posts. Ignored when Include notes is off.", "default": 100 } } }, "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 } } } } } } } } } }