{ "openapi": "3.0.1", "info": { "title": "RedNote (Xiaohongshu) Search Scraper - 500 Notes/30s", "description": "Extract Xiaohongshu (RedNote / 小纒书) search results by keyword. Get author profile, engagement counts (likes, comments, collects), image galleries, and playable video stream URLs β€” 24 fields per note. No headless browser, no captcha. 500 notes in 30s. Filter by note type. JSON/CSV/Excel export.", "version": "0.0", "x-build-id": "hEqD6O2H7OQcfwxDd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zen-studio~rednote-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zen-studio-rednote-search-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-search-scraper/runs": { "post": { "operationId": "runs-sync-zen-studio-rednote-search-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-search-scraper/run-sync": { "post": { "operationId": "run-sync-zen-studio-rednote-search-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": [ "keywords" ], "properties": { "keywords": { "title": "πŸ” Search keywords", "minItems": 1, "type": "array", "description": "Add one or more search terms.

β€’ Chinese works: 美食推荐, ε’–ε•‘, 穿搭
β€’ English works too: lululemon, iphone, tokyo

Each keyword runs independently with its own Max results budget.", "items": { "type": "string" } }, "maxResults": { "title": "πŸ“Š Max results per keyword", "minimum": 0, "maximum": 10000, "type": "integer", "description": "How many unique notes to collect for each keyword. Set 0 for all available (up to ~7,000 per keyword for broad terms).

Narrow keywords may yield fewer than the cap because the source has a finite catalogue per query.", "default": 100 }, "sortType": { "title": "Sort by", "enum": [ "general", "popularity_descending", "time_descending" ], "type": "string", "description": "How the source ranks results.

β€’ Most relevant β€” curated relevance ranker (default; balanced for most queries)
β€’ Most popular β€” by engagement (likes + comments); surfaces viral hits
β€’ Newest first β€” by publish time; for trend monitoring", "default": "general" }, "topUpFromOtherSorts": { "title": "Maximize results (all sorts + time ranges)", "type": "boolean", "description": "Gather across all sort modes and time ranges, merging and de-duplicating, to collect the most unique notes per keyword.

Recommended ON (default). Engages the deeper time-range sweep only when you raise Max results per keyword above 1,000; at or below 1,000 it behaves exactly as before.

Turn OFF to restrict to your chosen sort order only.", "default": true }, "noteType": { "title": "Note type", "enum": [ "all", "video", "image", "live" ], "type": "string", "description": "Restrict to a single note format.

β€’ All types β€” image + video + live (default)
β€’ Video notes β€” only entries with playable video
β€’ Image notes β€” only photo galleries
β€’ Live notes β€” only livestream replays (rare)", "default": "all" }, "timeFilter": { "title": "Time window", "enum": [ "all", "1d", "1w", "6mo" ], "type": "string", "description": "Restrict to notes published in a recent window. Use for trend monitoring or to avoid stale content.", "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 } } }, "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 } } } } } } } } } }