{ "openapi": "3.0.1", "info": { "title": "RedNote Trending Scraper: Xiaohongshu 小红书 Viral Notes & Text", "description": "Get the notes RedNote (Xiaohongshu, 小红书) is pushing right now, with full text, images, video link, tags, likes, saves, comments, shares, date and author. Filter by keyword, likes or date, or paste note links. No login, no cookies.", "version": "1.0", "x-build-id": "a6g01ZnLYFQHU57ed" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/serenido~rednote-trending-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-serenido-rednote-trending-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/serenido~rednote-trending-scraper/runs": { "post": { "operationId": "runs-sync-serenido-rednote-trending-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/serenido~rednote-trending-scraper/run-sync": { "post": { "operationId": "run-sync-serenido-rednote-trending-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": { "maxNotes": { "title": "Number of trending notes", "minimum": 0, "maximum": 1000, "type": "integer", "description": "How many notes to save from RedNote's main trending feed (up to 1,000). Set 0 to only read the note links below.", "default": 50 }, "fullDetail": { "title": "Open each note (full text and counts)", "type": "boolean", "description": "On: open every note for its full text, all images, video link, tags, saves, comments, shares, exact date and location. Off: faster, only what the feed shows (title, likes, author, cover, date, link).", "default": true }, "keywords": { "title": "Only notes about", "type": "array", "description": "Keep notes whose title, text or tags contain any of these words, for example 咖啡 or 护肤. Leave empty for everything. Skipped notes are not saved or charged.", "items": { "type": "string" } }, "minLikes": { "title": "Minimum likes", "minimum": 0, "type": "integer", "description": "Keep notes with at least this many likes. 0 = all.", "default": 0 }, "publishedWithinDays": { "title": "Posted within (days)", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Keep notes posted in the last N days. 0 = any date. The feed mostly shows notes from the last 3 months.", "default": 0 }, "noteUrls": { "title": "Note links", "type": "array", "description": "RedNote note links to read in full, with their xsec_token (copy them from the note's Share button or the browser address bar), or xhslink.com share links. Filters do not apply to links. Deleted, private or expired links are saved as free rows.", "items": { "type": "string" } }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many notes to open at the same time.", "default": 5 }, "proxy": { "title": "Proxy", "type": "object", "description": "Residential proxy is recommended: RedNote gives one address only a few feed loads, and the tool uses a fresh address for each one. Note pages try a cheaper datacenter address first.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }