{
  "openapi": "3.0.1",
  "info": {
    "title": "Douyin (Xingtu) Creator Rankings - Brand-Deal KOLs with Rates",
    "description": "Extract top Douyin (抖音) commercial creators with CPM rates, follower counts, brand-order metrics, and stable creator IDs from Xingtu (巨量星图) leaderboards. 7 industries: 美妆, 3C及电器, 食品饮料, 服装配饰, 汽车, 母婴宠物, 日化. Bucketed repurchase rates, top videos, optional similar-creator (达人) expansion. JSON/CSV/Excel.",
    "version": "0.0",
    "x-build-id": "GMvJcUjYEH8IsEOYV"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/zen-studio~douyin-xingtu-rankings-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-zen-studio-douyin-xingtu-rankings-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/zen-studio~douyin-xingtu-rankings-scraper/runs": {
      "post": {
        "operationId": "runs-sync-zen-studio-douyin-xingtu-rankings-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/zen-studio~douyin-xingtu-rankings-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-zen-studio-douyin-xingtu-rankings-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": [
          "industries",
          "creatorType",
          "timeWindow"
        ],
        "properties": {
          "industries": {
            "title": "🎯 Industry",
            "minItems": 1,
            "type": "array",
            "description": "Pick one or more industries. Each industry runs independently.<br><br>Some combinations of <b>creator type</b> may not be available for every industry — the actor will silently skip any combos with no published leaderboard.",
            "items": {
              "type": "string",
              "enum": [
                "美妆",
                "3C及电器",
                "食品饮料",
                "服装配饰",
                "汽车",
                "母婴宠物",
                "日化"
              ],
              "enumTitles": [
                "Beauty (美妆)",
                "3C & Electronics (3C及电器)",
                "Food & Beverage (食品饮料)",
                "Apparel & Accessories (服装配饰)",
                "Automotive (汽车)",
                "Mother & Baby & Pets (母婴宠物)",
                "Household Goods (日化)"
              ]
            },
            "default": [
              "美妆"
            ]
          },
          "creatorType": {
            "title": "👥 Creator type",
            "enum": [
              "top_creators",
              "rising_stars",
              "sales_champions",
              "viral_drivers",
              "paid_ad_performers",
              "head_tier",
              "all_top"
            ],
            "type": "string",
            "description": "Which kind of creators to pull from the Xingtu leaderboards.<br><br>• <b>Top creators</b> — best for brand deals (品牌优选榜)<br>• <b>Rising stars</b> — fast-growing, high-potential breakouts<br>• <b>Sales champions</b> — top by completed brand orders & e-commerce sales<br>• <b>Viral content drivers</b> — best at sparking searches & engagement (A3种草 + 看后搜)<br>• <b>Paid-ad performers</b> — highest ROI on paid promotion<br>• <b>Head-tier mega creators</b> — the most-booked head creators<br>• <b>All top creators (combined)</b> — power-user mega-run, combines all 6 brand-seeding boards",
            "default": "top_creators"
          },
          "timeWindow": {
            "title": "📅 Time window",
            "enum": [
              "latest_weekly",
              "latest_monthly",
              "all_history_monthly",
              "all_history_weekly"
            ],
            "type": "string",
            "description": "<b>Latest monthly</b> is the recommended default — fresh rankings, clean data. Use <b>All historical monthly</b> for trend analysis (much larger result set).",
            "default": "latest_monthly"
          },
          "maxResults": {
            "title": "📊 Max results",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Hard cap on emitted rows. Each unique creator counts toward your bill.<br><br>Defaults to 100 (one board's worth). Bump higher only if you've picked <b>All top creators</b> or multiple industries.",
            "default": 100
          },
          "includeSimilarCreators": {
            "title": "🔗 Include similar creators",
            "type": "boolean",
            "description": "Adds a second pass: for each ranked creator (top N per board), pulls similar creators via Xingtu's lookalike graph. Each lookalike counts as one result (same price). Use this to discover emerging creators below the top-100 cap.<br><br><b>Tip:</b> rankings load first, then similar. If <b>Max results</b> is below the ranking total (~100 per board), similar never fires. Set Max results to at least <code>100 + (top-N seeds × 12)</code> for similar to have room to emit.",
            "default": false
          },
          "similarExpandTopN": {
            "title": "Expand top N seeds per board",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Only matters when the toggle above is ON. For each ranked creator board, the first N rows become 'seeds' for similar-creator expansion. Higher N = more lookalikes, more cost.",
            "default": 20
          },
          "similarType": {
            "title": "Similarity dimension",
            "enum": [
              "content",
              "comprehension",
              "audience",
              "commercial"
            ],
            "type": "string",
            "description": "Which similarity dimension Xingtu uses to score lookalikes.<br><br>• <b>Content</b> — content style + topics (default; good general lookalikes)<br>• <b>Audience</b> — audience overlap<br>• <b>Commercial</b> — commercial profile (CPM, sales)<br>• <b>Comprehensive</b> — weighted combination",
            "default": "content"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}