{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu KOL Scraper 小红书蒲公英 [From $1] Prices & Audience", "description": "[From $1 per 1000 rows] Xiaohongshu (RedNote) influencer data from Pugongying (蒲公英): creator search with quoted note prices, reads, CPM and follower quality; profiles with audience age, gender and cities; keyword stats. No login. Creator search $10, profiles $150 per 1,000.", "version": "0.1", "x-build-id": "9I146xmr0P8fhjFdD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~xiaohongshu-kol-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-xiaohongshu-kol-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/memo23~xiaohongshu-kol-scraper/runs": { "post": { "operationId": "runs-sync-memo23-xiaohongshu-kol-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/memo23~xiaohongshu-kol-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-xiaohongshu-kol-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": { "keywords": { "title": "Creator search keywords", "type": "array", "description": "Find Pugongying creators by keyword (usually Chinese): a topic, product type or nickname. Each result is a `kol` row with quoted note prices, median reads and engagement, CPM estimates and follower quality.", "items": { "type": "string" } }, "maxResultsPerKeyword": { "title": "Max creators per keyword", "minimum": 3, "maximum": 2000, "type": "integer", "description": "Upper bound on creators per keyword. 20 arrive per page.", "default": 40 }, "creators": { "title": "Creators", "type": "array", "description": "Xiaohongshu profile links (`https://www.xiaohongshu.com/user/profile/63b8f39f0000000026013c5a`) or user ids. Each returns a `kol-profile` row: prices, performance against peers, reply rate and the audience breakdown.", "items": { "type": "string" } }, "includeAudience": { "title": "Audience breakdown", "type": "boolean", "description": "Add the audience to each creator profile: gender split, age groups, top interests, provinces, cities and devices.", "default": true }, "includePerformance": { "title": "Performance report", "type": "boolean", "description": "Add a `kol-performance` row per creator: 30-day medians for impressions, reads, likes, saves, comments and shares, engagement and completion rates, standing against peers, top notes, CPM and daily curve.", "default": false }, "includeFollowerHistory": { "title": "Follower history", "type": "boolean", "description": "Add a `kol-follower-history` row per creator: active, engaged, reading and paying follower shares, 30-day growth and the daily follower count.", "default": false }, "includeNotes": { "title": "Creator notes", "type": "boolean", "description": "Add the creator's notes as `kol-note` rows: title, reads, likes, saves, date, and whether it was sponsored and for which brand.", "default": false }, "maxNotesPerCreator": { "title": "Max notes per creator", "minimum": 3, "maximum": 400, "type": "integer", "description": "Upper bound on notes per creator. 8 arrive per page.", "default": 16 }, "notesOrder": { "title": "Notes order", "enum": [ "latest", "mostRead", "mostEngaged" ], "type": "string", "description": "Which of the creator's notes come first.", "default": "latest" }, "includeSimilar": { "title": "Similar creators", "type": "boolean", "description": "Add the creators Pugongying lists as similar, as `kol` rows with `source: \"similar\"`.", "default": false }, "keywordStats": { "title": "Keywords for statistics", "type": "array", "description": "For each keyword, one `keyword-stat` row: search score, number of notes and creators, impressions, reads and engagement with their 30-day change, plus what kind of creators post about it.", "items": { "type": "string" } }, "includeKeywordTrend": { "title": "Keyword daily trend", "type": "boolean", "description": "For each statistics keyword, add a `keyword-trend` row with about 90 days of daily search score, notes, creators, impressions, reads and engagement.", "default": false }, "includeRelatedKeywords": { "title": "Related keywords", "type": "boolean", "description": "For each statistics keyword, add up to 100 `related-keyword` rows: what people search before and after it, with search score and note counts.", "default": false }, "leaderboards": { "title": "Leaderboards", "uniqueItems": true, "type": "array", "description": "Pugongying's note leaderboards, 100 notes each, as `leaderboard-note` rows with reads, likes, saves, comments and the creator.", "items": { "type": "string", "enum": [ "hotNotes", "productSeeding", "ecommercePromotion", "pugongyingCollabs", "leadCollection", "ecommerceHot", "seedingDirect", "appPromotion" ], "enumTitles": [ "Hot on Xiaohongshu (小红书热门)", "Product seeding (产品种草)", "E-commerce promotion (电商推广)", "Pugongying collaborations (蒲公英合作)", "Lead collection (客资收集)", "E-commerce hot (电商热门)", "Seeding direct (种草直达)", "App promotion (应用推广)" ] } }, "leaderboardDays": { "title": "Leaderboard period", "enum": [ "3", "7", "14", "30" ], "type": "string", "description": "Period the leaderboards cover.", "default": "7" }, "leaderboardKeyword": { "title": "Leaderboard keyword", "type": "string", "description": "Keep only leaderboard notes matching this keyword." }, "maxItemsPerLeaderboard": { "title": "Max notes per leaderboard", "minimum": 7, "maximum": 100, "type": "integer", "description": "Upper bound on rows per leaderboard.", "default": 100 }, "includeLiveCreators": { "title": "Live-commerce creators", "type": "boolean", "description": "Return creators who sell through live streams, as `live-kol` rows: followers, live days, average viewers, sales and order-value ranges, categories sold.", "default": false }, "liveCreatorKeywords": { "title": "Live creator nicknames", "type": "array", "description": "Search live-commerce creators by nickname.", "items": { "type": "string" } }, "maxLiveCreators": { "title": "Max live creators", "minimum": 3, "maximum": 2000, "type": "integer", "description": "Upper bound on live-commerce creators per search.", "default": 20 }, "noteUrls": { "title": "Note links", "type": "array", "description": "Xiaohongshu note links or note ids. Each returns a `note-detail` row with impressions, reads, likes, saves, comments, shares, follows gained, text, hashtags and media. Works for notes of creators who are on Pugongying.", "items": { "type": "string" } }, "includeNoteComments": { "title": "Featured comments on notes", "type": "boolean", "description": "Add the note's featured comments and their replies to each `note-detail` row.", "default": false } } }, "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 } } } } } } } } } }