{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu (RedNote) Trending Discovery Scraper", "description": "Discover what is trending on Xiaohongshu (RedNote) right now — no login, no account, no cookies.", "version": "0.1", "x-build-id": "8bvVtMKLFQSz2U4rc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/foxlabs~xiaohongshu-trending-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-foxlabs-xiaohongshu-trending-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/foxlabs~xiaohongshu-trending-scraper/runs": { "post": { "operationId": "runs-sync-foxlabs-xiaohongshu-trending-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/foxlabs~xiaohongshu-trending-scraper/run-sync": { "post": { "operationId": "run-sync-foxlabs-xiaohongshu-trending-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": { "channels": { "title": "Channels to sweep", "type": "array", "description": "Which trending channels to pull from. Leave empty for all. Each channel is a RedNote home-feed category.", "items": { "type": "string", "enum": [ "recommend", "fashion", "food", "cosmetics", "movie_tv", "career", "emotion", "gaming", "travel", "fitness", "video" ], "enumTitles": [ "Recommended (for you)", "Fashion 穿搭", "Food 美食", "Cosmetics 彩妆", "Film & TV 影视", "Career 职场", "Emotion 情感", "Gaming 游戏", "Travel 旅行", "Fitness 健身", "Video 视频" ] }, "default": [] }, "maxResults": { "title": "Maximum number of unique notes", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on delivered trending notes (deduplicated by note id across the whole run). The feed refreshes on every request, so a sweep keeps bringing new notes until this cap or no new ones appear.", "default": 1000 }, "maxRounds": { "title": "Maximum sweeps of the channel list", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many times to loop over the selected channels at most. Each sweep returns a freshly refreshed feed. The run stops early when it reaches Max results or a whole sweep brings no new notes.", "default": 40 }, "country": { "title": "Proxy country", "enum": [ "CN", "HK" ], "type": "string", "description": "Residential exit country. Both work; try the other if one is slow or blocked.", "default": "CN" }, "maxRunSeconds": { "title": "Time budget (seconds, 0 = none)", "minimum": 0, "maximum": 36000, "type": "integer", "description": "Optional soft deadline. The run stops sweeping after this many seconds even if Max results is not reached. 0 means no time limit (only Max results / Max rounds apply).", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy is required (RedNote serves the trending state to residential IPs). Defaults to Apify Residential in the selected country.", "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 }, "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 } } } } } } } } } }