Xiaohongshu Keyword Search Scraper
Pricing
$0.10 / actor start
Go to Apify Store
Xiaohongshu Keyword Search Scraper
Search Xiaohongshu（小红书） notes by keyword. Filter by sort order, note type, and publishing time with automatic pagination.
Xiaohongshu Keyword Search Scraper
Pricing
$0.10 / actor start
Search Xiaohongshu（小红书） notes by keyword. Filter by sort order, note type, and publishing time with automatic pagination.
You can access the Xiaohongshu Keyword Search Scraper programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in API & Integrations in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "0.3", "x-build-id": "v9r9OQ0Id4JN9cJCt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/opspilot.cc~xiaohongshu-keyword-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-opspilot.cc-xiaohongshu-keyword-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/opspilot.cc~xiaohongshu-keyword-search-scraper/runs": { "post": { "operationId": "runs-sync-opspilot.cc-xiaohongshu-keyword-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/opspilot.cc~xiaohongshu-keyword-search-scraper/run-sync": { "post": { "operationId": "run-sync-opspilot.cc-xiaohongshu-keyword-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": [ "keyword" ], "properties": { "keyword": { "title": "Search keyword", "minLength": 1, "maxLength": 100, "type": "string", "description": "One Xiaohongshu search keyword, for example: 美食推荐. The Actor is locked to one keyword per run; use multiple runs to search different keywords.", "default": "美食推荐" }, "page": { "title": "Page number", "minimum": 1, "maximum": 10, "type": "integer", "description": "Page number, start from 1. The Actor calls the upstream once per page, so `page=3` makes 3 upstream requests. The default of 1 keeps every run cheap.", "default": 1 }, "searchId": { "title": "Search ID (for pagination)", "type": "string", "description": "Required when page >= 2. Copy from the previous run SUMMARY field `nextSearchId` (or from the first item's `rawData.search_id`). Leave blank for page = 1.", "default": "" }, "searchSessionId": { "title": "Search session ID (for pagination)", "type": "string", "description": "Required when page >= 2. Copy from the previous run SUMMARY field `nextSearchSessionId` (or from the first item's `rawData.search_session_id`). Leave blank for page = 1.", "default": "" }, "sortType": { "title": "Sort type", "enum": [ "general", "time_descending", "popularity_descending", "comment_descending", "collect_descending", "english_preferred" ], "type": "string", "description": "How Xiaohongshu ranks the returned notes. Defaults to `general` (Xiaohongshu general sort).", "default": "general" }, "noteType": { "title": "Note type", "enum": [ "不限", "视频笔记", "普通笔记", "直播笔记" ], "type": "string", "description": "Filter by note type. Defaults to `不限` (all types).", "default": "不限" }, "timeFilter": { "title": "Time filter", "enum": [ "不限", "一天内", "一周内", "半年内" ], "type": "string", "description": "Filter by publish time. Defaults to `不限` (all time).", "default": "不限" } } }, "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 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Xiaohongshu Keyword Search Scraper from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: