{ "openapi": "3.0.1", "info": { "title": "RedNote Search & User Profile Scraper", "description": "Search RedNote (Xiaohongshu) by keyword and scrape creator profiles: followers, likes, bio, location, verification, recent notes. Export CSV, Excel, JSON, XML.", "version": "0.1", "x-build-id": "3Qsmp6ltSSftv596a" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~rednote-search-users-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-rednote-search-users-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/parseforge~rednote-search-users-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-rednote-search-users-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/parseforge~rednote-search-users-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-rednote-search-users-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": { "searchTerms": { "title": "🔎 Search keywords", "type": "array", "description": "Keywords to search on RedNote, one per line. Chinese and English both work (for example 咖啡, skincare, Tokyo travel). Each keyword returns up to about 1,000 results (50 pages of 20), which is the depth RedNote's search serves.", "items": { "type": "string" } }, "userUrls": { "title": "👤 Profile links or user ids", "type": "array", "description": "RedNote profiles to read, one per line. Accepts a profile link (xiaohongshu.com/user/profile/...), a 24-character user id, an xhslink.com share link, or a note link (the Actor reads the note's author).", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" }, "searchResultType": { "title": "Search returns", "enum": [ "notes", "creators" ], "type": "string", "description": "Notes: one row per matching note. Creators: one profile row per unique author found for the keyword, for influencer discovery.", "default": "notes" }, "includeAuthorProfile": { "title": "Add author profile to each note", "type": "boolean", "description": "On: every note row also carries its author's follower count, likes and saves, bio, location, verification and more (one extra profile read per unique author). Off: faster, author name and avatar only.", "default": true }, "maxPagesPerKeyword": { "title": "Max pages per keyword", "minimum": 1, "maximum": 50, "type": "integer", "description": "Stop each keyword after this many result pages (20 notes a page). RedNote serves at most 50.", "default": 50 }, "noteType": { "title": "Note type", "enum": [ "any", "image", "video" ], "type": "string", "description": "Keep only image notes or only video notes.", "default": "any" }, "minLikes": { "title": "Minimum likes", "minimum": 0, "type": "integer", "description": "Keep notes with at least this many likes. 0 keeps everything.", "default": 0 }, "publishedAfter": { "title": "Published after", "type": "string", "description": "Keep notes published on or after this date (YYYY-MM-DD)." }, "minFollowers": { "title": "Minimum followers", "minimum": 0, "type": "integer", "description": "Keep profiles (and, when author profiles are on, notes) whose creator has at least this many followers. 0 keeps everything.", "default": 0 }, "includeSensitiveProfileFields": { "title": "Include gender, age, college and IP location", "type": "boolean", "description": "Off (default): gender, age, college and ipLocation read Not Requested. On: they are filled from the creator's public profile. These are personal data, so turn this on only when you have a lawful reason to process them.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify proxy settings. Datacenter is enough; residential also works.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }