{ "openapi": "3.0.1", "info": { "title": "RedNote (Xiaohongshu) Search Scraper", "description": "Search RedNote (Xiaohongshu, 小纒书) by keyword, note or creator link. Get title, text, hashtags, likes, collects, comments, shares, author and original-quality images and videos as clean JSON. Filters, sorting, live results, no account or cookies needed.", "version": "1.0", "x-build-id": "GS8wZAcMeXrxlzXNI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/insights_data~rednote-xiaohongshu-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-insights_data-rednote-xiaohongshu-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/insights_data~rednote-xiaohongshu-search-scraper/runs": { "post": { "operationId": "runs-sync-insights_data-rednote-xiaohongshu-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/insights_data~rednote-xiaohongshu-search-scraper/run-sync": { "post": { "operationId": "run-sync-insights_data-rednote-xiaohongshu-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": [ "urls" ], "properties": { "urls": { "title": "πŸ”— Keywords and RedNote links (bulk)", "minItems": 1, "type": "array", "description": "One entry per line. Accepted: plain keywords (Chinese or English, for example ε’–ε•‘ or lululemon), note links (xiaohongshu.com/explore/... or xhslink.com share links), bare note IDs, creator links copied from the site (they carry an access token) and search page links. Each keyword is a separate search with its own result budget. This list must have at least one entry; categories below are added on top of it.", "items": { "type": "string" } }, "channels": { "title": "🧭 Explore categories", "type": "array", "description": "Optional. Collect notes from RedNote's explore categories, one per line, for example food, travel, fashion or 美食. Use recommend for the main recommendation feed.", "default": [], "items": { "type": "string" } }, "maxNotesPerChannel": { "title": "πŸ“š Max notes per category", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Notes kept for each explore category. 0 means no cap. Free plan users get up to 10 results per run in total.", "default": 10 }, "maxResults": { "title": "πŸ“Š Max results per keyword", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Notes kept for each keyword after your filters. 0 means as many as can be found. Free plan users get up to 10 results per run in total; paid plans have no run limit.", "default": 10 }, "sortType": { "title": "πŸ† Sort by", "enum": [ "general", "popularity_descending", "time_descending", "most_collected", "most_commented", "most_shared", "most_engagement" ], "type": "string", "description": "Order of the saved notes. With any option other than 'Most relevant', each keyword's notes are saved once that keyword has been searched, sorted by your choice.", "default": "general" }, "noteType": { "title": "🎬 Note type", "enum": [ "all", "image", "video" ], "type": "string", "description": "Keep only photo notes, only video notes, or both.", "default": "all" }, "timeFilter": { "title": "πŸ•’ Time window", "enum": [ "all", "1d", "1w", "1m", "6mo", "1y" ], "type": "string", "description": "Keep only notes published within this window, counted back from today.", "default": "all" }, "publishedAfter": { "title": "πŸ“… Published after", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Keep only notes published on or after this date (YYYY-MM-DD)." }, "publishedBefore": { "title": "πŸ“† Published before", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Keep only notes published on or before this date (YYYY-MM-DD)." }, "minLikes": { "title": "πŸ’– Minimum likes", "minimum": 0, "type": "integer", "description": "Keep only notes with at least this many likes. 0 turns the filter off.", "default": 0 }, "minCollects": { "title": "⭐ Minimum collects", "minimum": 0, "type": "integer", "description": "Keep only notes with at least this many collects (saves). 0 turns the filter off.", "default": 0 }, "minComments": { "title": "πŸ’¬ Minimum comments", "minimum": 0, "type": "integer", "description": "Keep only notes with at least this many comments. 0 turns the filter off.", "default": 0 }, "strictKeywordMatch": { "title": "🎯 Keyword must appear in the note", "type": "boolean", "description": "Drop notes whose text does not contain the keyword. Turn off to keep everything found for the keyword.", "default": true }, "keywordMatchIn": { "title": "πŸ”€ Where to look for the keyword", "uniqueItems": true, "type": "array", "description": "Parts of the note checked by the keyword match.", "items": { "type": "string", "enum": [ "title", "description", "hashtags" ], "enumTitles": [ "Title", "Description", "Hashtags" ] }, "default": [ "title", "description", "hashtags" ] }, "includeMedia": { "title": "πŸŒ„ Include images and video links", "type": "boolean", "description": "Add original-quality image links, the video link and the cover to every note.", "default": true }, "includeAllVideoStreams": { "title": "πŸŽ₯ Include every video quality", "type": "boolean", "description": "List every available video version (all codecs and resolutions) instead of just the best compatible one.", "default": false }, "includeAuthorDetails": { "title": "🎨 Include author details", "type": "boolean", "description": "Add followers, location, bio and gender for each note's author. Costs one extra request per unique author, so runs take longer.", "default": false }, "maxConcurrency": { "title": "πŸš€ Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many notes are fetched at the same time (1-10). Lower it if you see many blocks.", "default": 4 }, "requestDelaySeconds": { "title": "🐒 Pause between requests", "minimum": 0, "maximum": 30, "type": "number", "description": "Base pause in seconds between pages; a random extra is added.", "default": 1 }, "maxRetries": { "title": "πŸ” Retries per request", "minimum": 1, "maximum": 10, "type": "integer", "description": "Total attempts per request, including the first one (1-10).", "default": 3 }, "proxyConfiguration": { "title": "🌐 Proxy", "type": "object", "description": "Starts without a proxy. If requests are refused, the run switches to a datacenter proxy, then to a residential proxy, and stays there. You can also pick your own proxy here.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }