{
  "openapi": "3.0.1",
  "info": {
    "title": "Bilibili Huahuo 花火 KOL Scraper - Creator Rates & Audience",
    "description": "Find Bilibili KOLs (UP主) on the Huahuo (花火) creator marketplace by keyword, category and follower range, with commercial quotes, median plays and CPM. Get full profiles with audience breakdown and top videos. No login or cookies needed. Export to JSON, CSV or Excel.",
    "version": "0.1",
    "x-build-id": "xbx6XLufPMsOlqGuO"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/clover_folktale~huahuo-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-clover_folktale-huahuo-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/clover_folktale~huahuo-scraper/runs": {
      "post": {
        "operationId": "runs-sync-clover_folktale-huahuo-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/clover_folktale~huahuo-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-clover_folktale-huahuo-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": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "creator",
              "creatorTrends",
              "liveCreator",
              "rankings",
              "similarCreators",
              "representativeVideos",
              "liveSearch"
            ],
            "type": "string",
            "description": "What to scrape: UP hosts matching a search, full profiles, trend reports, live-streaming profiles, ranking boards, similar UP hosts, representative videos, or live streamers matching a search.",
            "default": "search"
          },
          "keyword": {
            "title": "Keyword (modes: search, liveSearch)",
            "type": "string",
            "description": "Search term. Optional: leave empty to browse UP hosts with the filters below only."
          },
          "searchBy": {
            "title": "Search by (mode: search)",
            "enum": [
              "content",
              "nickname"
            ],
            "type": "string",
            "description": "Match the keyword against what the UP hosts publish, or against their nicknames.",
            "default": "content"
          },
          "category": {
            "title": "Category (modes: search, liveSearch, rankings topCreators)",
            "enum": [
              "any",
              "entertainment",
              "knowledge",
              "film-tv",
              "music",
              "news",
              "kichiku",
              "documentary",
              "games",
              "lifestyle",
              "chinese-animation",
              "animation",
              "sports",
              "premium-content",
              "tech",
              "dance",
              "cars",
              "anime-series",
              "animals",
              "fashion",
              "food",
              "tv-series"
            ],
            "type": "string",
            "description": "Only UP hosts in this Bilibili content category. The topCreators ranking needs one of: games, tech, animation, fashion, food, knowledge, cars, film-tv, music, animals, lifestyle, kichiku, entertainment, dance, sports (default tech).",
            "default": "any"
          },
          "minFollowers": {
            "title": "Min followers (modes: search, liveSearch)",
            "minimum": 0,
            "type": "integer",
            "description": "Only UP hosts with at least this many followers."
          },
          "maxFollowers": {
            "title": "Max followers (modes: search, liveSearch)",
            "minimum": 0,
            "type": "integer",
            "description": "Only UP hosts with at most this many followers."
          },
          "liveAreas": {
            "title": "Live area (mode: liveSearch)",
            "type": "array",
            "description": "Only streamers who stream in these live areas. Use a sub-area name like CS2 or 唱见, or a whole area name (娱乐, 网游, 手游, 电台, 单机游戏, 虚拟主播, 生活, 知识, 大事件, 赛事, 聊天室, 互动玩法, 购物) for all of its sub-areas. Names are as shown on the marketplace (Chinese).",
            "items": {
              "type": "string"
            }
          },
          "sort": {
            "title": "Sort (mode: search)",
            "enum": [
              "relevance",
              "followers",
              "median-plays",
              "interaction-rate"
            ],
            "type": "string",
            "description": "Order of the results.",
            "default": "relevance"
          },
          "sortOrder": {
            "title": "Sort order (mode: search)",
            "enum": [
              "desc",
              "asc"
            ],
            "type": "string",
            "description": "Highest first or lowest first. Ignored for best match.",
            "default": "desc"
          },
          "regions": {
            "title": "Province or city (mode: search)",
            "type": "array",
            "description": "Only UP hosts living in these provinces or municipalities. Several allowed.",
            "items": {
              "type": "string",
              "enum": [
                "北京",
                "上海",
                "天津",
                "重庆",
                "福建",
                "广东",
                "吉林",
                "辽宁",
                "内蒙古",
                "贵州",
                "宁夏",
                "浙江",
                "江苏",
                "安徽",
                "山东",
                "黑龙江",
                "山西",
                "陕西",
                "广西",
                "河南",
                "四川",
                "河北",
                "云南",
                "湖北",
                "西藏",
                "甘肃",
                "海南",
                "新疆",
                "青海",
                "江西",
                "湖南",
                "香港",
                "台湾",
                "澳门",
                "海外"
              ]
            }
          },
          "fansGender": {
            "title": "Audience gender (mode: search)",
            "type": "array",
            "description": "Only UP hosts whose followers are mostly of one gender, e.g. men above 70 percent. Several allowed.",
            "items": {
              "type": "string",
              "enum": [
                "男性占比大于50%",
                "男性占比大于60%",
                "男性占比大于70%",
                "男性占比大于80%",
                "女性占比大于50%",
                "女性占比大于60%",
                "女性占比大于70%",
                "女性占比大于80%"
              ]
            }
          },
          "identities": {
            "title": "Identity (mode: search)",
            "type": "array",
            "description": "Only UP hosts with one of these professions or roles (photographer, singer, gamer, ...). Several allowed; with the two lists below, a UP host matching any chosen label is returned.",
            "items": {
              "type": "string",
              "enum": [
                "摄影师",
                "配音演员",
                "设计师",
                "歌手",
                "演员",
                "教师",
                "作家",
                "主持",
                "舞者",
                "虚拟UP主",
                "解说",
                "游戏选手",
                "主播",
                "化妆师",
                "发型师",
                "模特",
                "coser",
                "医生",
                "皮肤专家",
                "整形专家",
                "配方专家",
                "程序员",
                "厨师",
                "游戏教练",
                "游戏策划",
                "游戏美术",
                "游戏制作人",
                "导演"
              ]
            }
          },
          "personas": {
            "title": "Persona (mode: search)",
            "type": "array",
            "description": "Only UP hosts with one of these personas (office worker, student, ...).",
            "items": {
              "type": "string",
              "enum": [
                "职场人",
                "学生党",
                "亲子类",
                "情侣党",
                "萌宠向",
                "田园向"
              ]
            }
          },
          "contentTypes": {
            "title": "Content type (mode: search)",
            "type": "array",
            "description": "Only UP hosts making one of these types of content, like game playthroughs, food reviews or digital reviews.",
            "items": {
              "type": "string",
              "enum": [
                "AI短片",
                "AI整活",
                "户外全能",
                "户外探险",
                "旅游出行",
                "户外骑行",
                "户外钓鱼",
                "户外滑雪",
                "户外攀登攀岩",
                "彩妆向",
                "护肤向",
                "香氛向",
                "美发向",
                "日常穿搭",
                "时尚解读",
                "LOLITA/JK/汉服穿搭",
                "游戏实况",
                "游戏试玩",
                "游戏电竞",
                "游戏杂谈",
                "游戏攻略",
                "游戏混剪",
                "游戏创意",
                "美食探店",
                "美食制作",
                "美食测评",
                "美食记录",
                "绘画书法",
                "生活Vlog",
                "旅行记录",
                "软件应用",
                "装机拆解",
                "数码测评",
                "家电测评",
                "知识科普",
                "社科杂谈",
                "学习干货",
                "名师学者",
                "考研",
                "考公",
                "编程技术",
                "兼职副业",
                "成人英语",
                "动漫杂谈",
                "MAD/MMD制作",
                "原创动画",
                "拆改测评",
                "汽车科技",
                "汽车文化",
                "运动健身",
                "营养保健",
                "医药健康",
                "滋补养生",
                "医疗机构",
                "健康器械",
                "影娱剪辑",
                "影娱杂谈",
                "家居房产",
                "微型综艺",
                "搞笑表演",
                "好物种草",
                "线下探店",
                "短片配音",
                "创意TVC",
                "仿妆/COS",
                "创意剧情",
                "硬核手工",
                "鬼畜调教",
                "鬼畜剧场",
                "原创舞蹈",
                "舞蹈翻跳",
                "原创音乐",
                "翻唱改编",
                "音乐演奏",
                "宠物日常"
              ]
            }
          },
          "workType": {
            "title": "Video type (mode: representativeVideos)",
            "enum": [
              "commercial",
              "personal"
            ],
            "type": "string",
            "description": "Sponsored videos or organic videos of the UP host.",
            "default": "commercial"
          },
          "trendSections": {
            "title": "Trend sections, one or two (mode: creatorTrends)",
            "type": "array",
            "description": "Which views the trend report holds; each one costs us one data request, so pick at most two. followers: daily followers and growth. videoPlays: plays of recent videos. contentMix: content mix and sponsored-video count. highlights: hit and explosive video rates. Default: followers and videoPlays.",
            "items": {
              "type": "string",
              "enum": [
                "followers",
                "videoPlays",
                "contentMix",
                "highlights"
              ],
              "enumTitles": [
                "Followers",
                "Recent video plays",
                "Content mix",
                "Hit videos"
              ]
            },
            "default": [
              "followers",
              "videoPlays"
            ]
          },
          "ranking": {
            "title": "Ranking board (mode: rankings)",
            "enum": [
              "videos",
              "products",
              "productCreators",
              "industryCreators",
              "topCreators",
              "xHuoCreators"
            ],
            "type": "string",
            "description": "videos: video ranking, one page holds 15 (up to 200). products: product ranking (up to 100). productCreators: UP hosts selling one product (needs productId). industryCreators: UP hosts selling in one industry (up to 50). topCreators: top UP hosts of a category (10). xHuoCreators: X-Huo seeding board of UP hosts of one industry, monthly or quarterly (50).",
            "default": "videos"
          },
          "videoIndustry": {
            "title": "Video industry (mode: rankings, board videos)",
            "enum": [
              "any",
              "digital-appliances",
              "beauty",
              "cars"
            ],
            "type": "string",
            "description": "Industry of the video ranking.",
            "default": "any"
          },
          "productIndustry": {
            "title": "Product industry (mode: rankings, boards products and industryCreators)",
            "enum": [
              "digital-appliances",
              "beauty",
              "food-beverage",
              "apparel",
              "home",
              "mother-baby-pets",
              "phones",
              "computers",
              "digital-accessories",
              "large-appliances",
              "small-appliances"
            ],
            "type": "string",
            "description": "Industry of the product ranking.",
            "default": "digital-appliances"
          },
          "productId": {
            "title": "Product ID (mode: rankings, board productCreators)",
            "type": "string",
            "description": "The productId of a row from the products ranking."
          },
          "xHuoIndustry": {
            "title": "X-Huo industry (mode: rankings, board xHuoCreators)",
            "enum": [
              "digital-appliances",
              "beauty",
              "health",
              "home",
              "apparel",
              "mother-baby-pets",
              "digital-products",
              "small-appliances",
              "computers",
              "large-appliances"
            ],
            "type": "string",
            "description": "Industry of the X-Huo seeding board of UP hosts.",
            "default": "digital-appliances"
          },
          "rankPeriod": {
            "title": "X-Huo period (mode: rankings, board xHuoCreators)",
            "enum": [
              "monthly",
              "quarterly"
            ],
            "type": "string",
            "description": "Monthly or quarterly X-Huo board.",
            "default": "monthly"
          },
          "rankDate": {
            "title": "X-Huo month (mode: rankings, board xHuoCreators)",
            "type": "string",
            "description": "A month like 2026-08 of the monthly X-Huo board. Empty: the latest month (or quarter). Only months the marketplace has published exist (2025-01 up to last month)."
          },
          "creators": {
            "title": "UP hosts (modes: creator, creatorTrends, liveCreator, similarCreators, representativeVideos)",
            "type": "array",
            "description": "Bilibili UIDs (the userId of a search result) or space.bilibili.com links, e.g. https://space.bilibili.com/647398719. One report per UP host.",
            "items": {
              "type": "string"
            }
          },
          "creatorNames": {
            "title": "UP host nicknames (modes: creator, creatorTrends, liveCreator, similarCreators, representativeVideos)",
            "type": "array",
            "description": "Nicknames instead of (or next to) UIDs. Each nickname is looked up first; the UP host whose nickname matches exactly is used, otherwise the first match. Every nickname pays extra start fees for its lookup, see the README.",
            "items": {
              "type": "string"
            }
          },
          "maxResults": {
            "title": "Max results",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Maximum number of items to return in total for this run. You are charged per item returned.",
            "default": 20
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}