{ "openapi": "3.0.1", "info": { "title": "Red Note Scraper", "description": "Scrape Red Note (Xiaohongshu) posts from home-feed categories or URLs. Optionally attach creator profiles and top comments. Structured JSON for agents, with pay-per-event charging for posts, profiles, and comments.", "version": "1.0", "x-build-id": "vNlYbgMrtF81BtfMF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rigelbytes~rednote-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rigelbytes-rednote-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/rigelbytes~rednote-scraper/runs": { "post": { "operationId": "runs-sync-rigelbytes-rednote-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/rigelbytes~rednote-scraper/run-sync": { "post": { "operationId": "run-sync-rigelbytes-rednote-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", "properties": { "searchQueries": { "title": "Search Queries", "type": "array", "description": "Home-feed categories to scrape, written as names or keys (e.g. \"fashion\", \"food\", \"For you\"). Same values as Categories — useful for AI agents that pass intent instead of URLs.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Home-feed categories to scrape on rednote.com (e.g. for_you, fashion, food). Combined with Start URLs when both are set.", "items": { "type": "string", "enum": [ "for_you", "fashion", "food", "beauty", "tv_movies", "career", "love_life", "home_decor", "gaming", "travel", "fitness", "videos" ], "enumTitles": [ "For you", "Fashion", "Food", "Beauty", "TV & movies", "Career", "Love & life", "Home decor", "Gaming", "Travel", "Fitness", "Videos" ] } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Red Note or Xiaohongshu note, profile, or home-feed URLs (e.g. https://www.rednote.com/, https://www.rednote.com/explore/64aac459000000002f02b151, https://www.rednote.com/user/profile/62c834b7000000000303ed1e). Category, note, and profile URLs are all accepted.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max Posts", "minimum": 0, "type": "integer", "description": "Maximum number of posts to scrape across all categories and URLs (0 = unlimited).", "default": 0 }, "scrapeProfiles": { "title": "Extract creator profiles", "type": "boolean", "description": "When enabled, fetch the creator profile for each post (bio, followers, Red ID). Charged as the profile-details event once per unique profile, in addition to each dataset item.", "default": false }, "scrapeComments": { "title": "Extract top comments", "type": "boolean", "description": "When enabled, fetch top-level comments for each post. Charged as the comment event once per comment, in addition to each dataset item.", "default": false }, "maxComments": { "title": "Max comments per post", "minimum": 0, "type": "integer", "description": "Maximum number of top comments to collect per post when Extract top comments is enabled (0 = all comments returned on the first pages).", "default": 10 }, "detailConcurrency": { "title": "Detail concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many posts to enrich in parallel (details, profiles, and comments). Higher is faster; keep it modest to avoid blocks.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Apify Residential proxies are recommended for reliable Red Note access.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }