{ "openapi": "3.0.1", "info": { "title": "RedNote Scraper + Consumer & Competitor Analysis", "description": "Paste one RedNote/Xiaohongshu URL, keyword, profile, or Apify Dataset ID. Live collection uses your Cookie when Xiaohongshu requires sign-in; Dataset/uploaded analysis needs no Cookie. Get note rows or topic, creator, competitor, consumer-voice, and market reports. $0.00599/note or $0.99/report.", "version": "0.2", "x-build-id": "CSkb4194mLwn8fcQX" }, "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", "required": [ "source" ], "properties": { "source": { "title": "Note URL, keyword, profile, topic, brands, or Dataset ID", "type": "string", "description": "Examples: a note URL; 防晒; a creator profile URL; Nike, Adidas; or dataset:DATASET_ID." }, "outputType": { "title": "Deliverable", "enum": [ "noteResults", "topicRadar", "consumerVoice", "marketMap", "creatorAudit", "brandCompare" ], "type": "string", "description": "Raw note rows cost $0.00599 each. Any analysis option costs $0.99 for one completed report.", "default": "noteResults" }, "cookie": { "title": "Xiaohongshu Cookie (secret, for live collection)", "type": "string", "description": "Required whenever Xiaohongshu blocks or signs the requested live page, and for keyword/profile collection. Not needed for Dataset or uploaded-data analysis. Used only during this run; never written to output or logs." }, "maxItems": { "title": "Maximum note results", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum successfully parsed notes. Raw note collection costs at most $0.599 for 100 results.", "default": 100 }, "uploadedNotes": { "title": "Existing note data", "type": "array", "description": "Paste note records exported from any compatible Xiaohongshu/RedNote Actor.", "default": [] }, "uploadedComments": { "title": "Existing comment data", "type": "array", "description": "Paste comment records or strings for consumer voice and market-map reports.", "default": [] }, "brandDatasets": { "title": "Brand datasets", "type": "array", "description": "For a no-Cookie brand comparison: [{\"brand\":\"A\",\"notes\":[...]},{\"brand\":\"B\",\"notes\":[...]}].", "default": [] }, "knownEntities": { "title": "Brands, products, ingredients, and alternatives", "type": "array", "description": "Names to measure in uploaded or collected discussions.", "default": [], "items": { "type": "string" } }, "regulatedTopic": { "title": "Regulated health or 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 consumer questions and supporting excerpts returned in a report.", "default": 20 }, "maxOpportunities": { "title": "Maximum content opportunities", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum ranked ideas inside the single $0.99 topic report.", "default": 10 }, "brandKeywords": { "title": "Terms to score in collected note rows", "type": "array", "description": "Case-insensitive terms used only to score raw note results.", "default": [], "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Used only for authenticated Cookie-based collection.", "default": { "useApifyProxy": false } }, "htmlSnapshots": { "title": "Saved public-note HTML snapshots", "type": "array", "description": "Optional authorized snapshot input for deterministic extraction.", "default": [] }, "requestDelayMs": { "title": "Delay between public URL attempts", "minimum": 500, "maximum": 10000, "type": "integer", "description": "Polite delay used for public note-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 } } } } } } } } } }