{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu KOL Scraper - 蒲公英 Creator Rates & Audience", "description": "Find Xiaohongshu (小红书 / RedNote) creators on the 蒲公英 marketplace: KOL search with follower, price, category and audience filters, lookalike creators, quoted note prices, 30-day performance reports, fan portraits and note read counts. Export to JSON/CSV/Excel.", "version": "1.0", "x-build-id": "PM6rUt5IW8sjTmVLD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vulnv~xiaohongshu-kol-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vulnv-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/vulnv~xiaohongshu-kol-scraper/runs": { "post": { "operationId": "runs-sync-vulnv-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/vulnv~xiaohongshu-kol-scraper/run-sync": { "post": { "operationId": "run-sync-vulnv-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", "required": [ "operation" ], "properties": { "operation": { "title": "⚙️ Operation", "enum": [ "search_kols", "similar_kols", "kol_profile", "kol_performance", "fan_portrait", "kol_notes" ], "type": "string", "description": "What to fetch. Each operation uses a different input field below:\n\n• Search creators (KOLs) → Keywords and / or filters\n• Similar creators → Creator URLs / IDs (+ optional filters)\n• Creator profile & rates → Creator URLs / IDs\n• Note performance report → Creator URLs / IDs\n• Fan / audience portrait → Creator URLs / IDs\n• Creator's notes → Creator URLs / IDs", "default": "search_kols" }, "keywords": { "title": "🔎 Search keywords", "type": "array", "description": "For \"Search creators\". Add one or more keywords - each is searched independently and duplicate creators across keywords are removed. By default a keyword matches creators whose notes are about it (e.g. 咖啡, 护肤, 露营); switch \"Search by\" to nickname to look creators up by name. Leave empty to browse every listed creator that matches the filters below (at least one filter is then required).", "items": { "type": "string" } }, "userUrls": { "title": "👤 Creator URLs / IDs", "type": "array", "description": "For every operation except \"Search creators\". Paste Xiaohongshu profile URLs (xiaohongshu.com/user/profile/), 蒲公英 creator page URLs, or bare 24-character creator IDs (e.g. 599019f082ec3967d2a034e5) - one per line. The user_id column of any search result is a valid ID.", "items": { "type": "string" } }, "maxItems": { "title": "📊 Maximum results per input", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Upper bound on results per keyword / creator for the list operations (search, similar creators, creator's notes). Cost scales linearly. Set 0 to fetch all available (creator searches stop at 5,000, the marketplace's own limit).", "default": 100 }, "searchBy": { "title": "🧭 Search by", "enum": [ "notes", "nickname" ], "type": "string", "description": "For \"Search creators\" only. Match the keyword against what creators post about (default) or against their nickname.", "default": "notes" }, "sortBy": { "title": "📈 Sort creators by", "enum": [ "smart", "followers", "price", "picture_price", "video_price", "read_median", "engagement_median", "picture_cost_per_read", "video_cost_per_read", "follower_growth", "reply_rate", "thousand_like_ratio" ], "type": "string", "description": "For \"Search creators\" and \"Similar creators\".", "default": "smart" }, "sortDirection": { "title": "↕️ Sort direction", "enum": [ "desc", "asc" ], "type": "string", "description": "Highest first or lowest first.", "default": "desc" }, "contentCategories": { "title": "🏷️ Creator categories", "type": "array", "description": "Only creators in any of these content categories.", "items": { "type": "string", "enum": [ "美妆", "护肤", "个人护理", "母婴", "时尚", "美食", "家居家装", "影视综资讯", "运动健身", "宠物", "文化艺术", "兴趣爱好", "生活记录", "教育", "职场", "情感", "摄影", "游戏", "科技数码", "出行旅游", "音乐", "搞笑", "健康养生", "汽车", "婚嫁", "商业财经", "素材", "其他" ], "enumTitles": [ "美妆 (Beauty / makeup)", "护肤 (Skincare)", "个人护理 (Personal care)", "母婴 (Mother & baby)", "时尚 (Fashion)", "美食 (Food)", "家居家装 (Home & decor)", "影视综资讯 (Film, TV & entertainment)", "运动健身 (Sports & fitness)", "宠物 (Pets)", "文化艺术 (Culture & art)", "兴趣爱好 (Hobbies)", "生活记录 (Lifestyle)", "教育 (Education)", "职场 (Career)", "情感 (Relationships)", "摄影 (Photography)", "游戏 (Gaming)", "科技数码 (Tech & gadgets)", "出行旅游 (Travel)", "音乐 (Music)", "搞笑 (Comedy)", "健康养生 (Health & wellness)", "汽车 (Cars)", "婚嫁 (Weddings)", "商业财经 (Business & finance)", "素材 (Stock material)", "其他 (Other)" ] } }, "creatorGender": { "title": "🚻 Creator gender", "enum": [ "any", "female", "male" ], "type": "string", "description": "Only creators of this gender.", "default": "any" }, "creatorLocations": { "title": "📍 Creator locations", "type": "array", "description": "Only creators based in any of these places. Use Chinese place names, e.g. 上海, 北京, 广东, 杭州.", "items": { "type": "string" } }, "agencyType": { "title": "🏢 Agency (MCN) status", "enum": [ "any", "individual", "agency" ], "type": "string", "description": "Independent creators only, agency-signed creators only, or both.", "default": "any" }, "minFollowers": { "title": "👥 Min followers", "minimum": 0, "type": "integer", "description": "Only creators with at least this many followers. 0 = no minimum." }, "maxFollowers": { "title": "👥 Max followers", "minimum": 0, "type": "integer", "description": "Only creators with at most this many followers. 0 = no maximum." }, "minPicturePrice": { "title": "💴 Min image-note price (CNY)", "minimum": 0, "type": "integer", "description": "Only creators whose quoted image-note price is at least this. 0 = no minimum." }, "maxPicturePrice": { "title": "💴 Max image-note price (CNY)", "minimum": 0, "type": "integer", "description": "Only creators whose quoted image-note price is at most this. 0 = no maximum." }, "minVideoPrice": { "title": "🎬 Min video-note price (CNY)", "minimum": 0, "type": "integer", "description": "Only creators whose quoted video-note price is at least this. 0 = no minimum." }, "maxVideoPrice": { "title": "🎬 Max video-note price (CNY)", "minimum": 0, "type": "integer", "description": "Only creators whose quoted video-note price is at most this. 0 = no maximum." }, "recentIndustry": { "title": "🤝 Recent brand-deal industry", "enum": [ "any", "美妆个护", "食品饮料", "母婴", "3c及电器", "日用百货", "服装配饰", "互联网", "生活服务", "家居建材", "汽车" ], "type": "string", "description": "Only creators who recently did sponsored notes in this industry.", "default": "any" }, "fanGender": { "title": "👩 Audience gender", "enum": [ "any", "mostly_female", "mostly_male" ], "type": "string", "description": "Only creators whose audience is mostly this gender.", "default": "any" }, "fanAge": { "title": "🎂 Main audience age", "enum": [ "any", "under_18", "18_24", "25_34", "35_44", "over_44" ], "type": "string", "description": "Only creators whose audience skews to this age band.", "default": "any" }, "fanLocations": { "title": "🗺️ Audience locations", "type": "array", "description": "Only creators with a strong audience in any of these places (province or city, in Chinese, e.g. 上海, 杭州).", "items": { "type": "string" } }, "noteType": { "title": "📝 Note type", "enum": [ "all", "image", "video", "sponsored" ], "type": "string", "description": "For \"Creator's notes\" only.", "default": "all" }, "noteSort": { "title": "🔃 Note order", "enum": [ "newest", "most_read", "most_engaged" ], "type": "string", "description": "For \"Creator's notes\" only.", "default": "newest" }, "performanceWindow": { "title": "📅 Report window", "enum": [ "30d", "90d" ], "type": "string", "description": "For \"Note performance report\" only.", "default": "30d" }, "noteScope": { "title": "📣 Notes to analyse", "enum": [ "organic", "sponsored" ], "type": "string", "description": "For \"Note performance report\" only. Everyday (organic) notes or sponsored brand-deal notes.", "default": "organic" } } }, "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 } } } } } } } } } }