{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu / RedNote Scraper & Intelligence", "description": "Scrape or analyze Xiaohongshu and RedNote notes and comments for content opportunities, creator audits, competitor comparisons, consumer voice insights, and market maps. Use uploaded datasets without cookies or collect notes with your own session.", "version": "0.1", "x-build-id": "xwoFqyWdbqTWS0utE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrupulous_buckler~xiaohongshu-brand-influencer-discovery/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrupulous_buckler-xiaohongshu-brand-influencer-discovery", "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/scrupulous_buckler~xiaohongshu-brand-influencer-discovery/runs": { "post": { "operationId": "runs-sync-scrupulous_buckler-xiaohongshu-brand-influencer-discovery", "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/scrupulous_buckler~xiaohongshu-brand-influencer-discovery/run-sync": { "post": { "operationId": "run-sync-scrupulous_buckler-xiaohongshu-brand-influencer-discovery", "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": { "mode": { "title": "Analysis or collection mode", "enum": [ "demo", "topicRadar", "consumerVoice", "marketMap", "creatorAudit", "brandCompare", "snapshot", "note", "search", "userPosts" ], "type": "string", "description": "Start with the demo, analyze uploaded data without a Cookie, or collect with your own Xiaohongshu session.", "default": "demo" }, "cookie": { "title": "Xiaohongshu Cookie (secret)", "type": "string", "description": "Required for note, search, and creator-post API modes. Never included in output or logs." }, "query": { "title": "Topic or search keyword", "type": "string", "description": "The category, consumer topic, or keyword being researched." }, "uploadedNotes": { "title": "Existing note data (no Cookie required)", "type": "array", "description": "Paste note records exported from any compatible Xiaohongshu Actor. Used by all intelligence modes.", "default": [] }, "uploadedComments": { "title": "Existing comment data (no Cookie required)", "type": "array", "description": "Paste comment records or strings. Common text/content/comment, id/commentId, noteId, and URL fields are recognized.", "default": [] }, "knownEntities": { "title": "Brands, products, ingredients, and alternatives", "type": "array", "description": "Names to measure in consumer discussions, for example brands, products, ingredients, devices, medicines, foods, or lifestyle alternatives.", "default": [], "items": { "type": "string" } }, "regulatedTopic": { "title": "Regulated health or other sensitive topic", "type": "boolean", "description": "Adds claim-risk evidence and safer framing. This is a screening aid, not legal or medical approval.", "default": false }, "maxEvidence": { "title": "Maximum evidence excerpts", "minimum": 5, "maximum": 100, "type": "integer", "description": "Maximum number of consumer questions and supporting excerpts returned in a report.", "default": 20 }, "brandDatasets": { "title": "Brand datasets", "type": "array", "description": "For brand comparison without a Cookie: [{\"brand\":\"A\",\"notes\":[...]},{\"brand\":\"B\",\"notes\":[...]}].", "default": [] }, "maxOpportunities": { "title": "Maximum content opportunities", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum ranked ideas returned by content opportunity radar. Each returned opportunity is a paid event.", "default": 10 }, "noteUrlOrId": { "title": "Note URL or ID", "type": "string", "description": "A Xiaohongshu note URL (keep xsec_token when present) or note ID." }, "userUrlOrId": { "title": "Creator profile URL or user ID", "type": "string", "description": "Required in creator posts mode." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy is recommended for authenticated modes.", "default": { "useApifyProxy": false } }, "startUrls": { "title": "Public note URLs", "type": "array", "description": "Public Xiaohongshu note URLs to analyze.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "htmlSnapshots": { "title": "HTML snapshots", "type": "array", "description": "Optional saved pages for testing or authorized snapshot workflows.", "default": [] }, "brandKeywords": { "title": "Brand or category keywords", "type": "array", "description": "Case-insensitive terms used to identify relevant notes.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Maximum successful results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stops after this many successfully parsed, unique notes.", "default": 100 }, "requestDelayMs": { "title": "Delay between requests", "minimum": 500, "maximum": 10000, "type": "integer", "description": "Polite delay between public-page requests.", "default": 1500 } } }, "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 } } } } } } } } } }