{
  "openapi": "3.0.1",
  "info": {
    "title": "TikTok Shop Creators — Search, Rankings & Analytics",
    "description": "Find TikTok creators by market, followers, engagement and commerce performance. Get profiles, rankings, related products, videos and livestreams, and similar creators. Export structured results as JSON, CSV or Excel.",
    "version": "0.0",
    "x-build-id": "5Q6WWV4HjaIreiURZ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/datanebula~tiktok-shop-creators/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-datanebula-tiktok-shop-creators",
        "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/datanebula~tiktok-shop-creators/runs": {
      "post": {
        "operationId": "runs-sync-datanebula-tiktok-shop-creators",
        "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/datanebula~tiktok-shop-creators/run-sync": {
      "post": {
        "operationId": "run-sync-datanebula-tiktok-shop-creators",
        "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",
          "country"
        ],
        "properties": {
          "operation": {
            "title": "Operation",
            "enum": [
              "creators-search",
              "creators-ranking-agencies",
              "creators-ranking-commercial",
              "creators-ranking-growth",
              "creators-detail",
              "creators-lives",
              "creators-products",
              "creators-similar",
              "creators-videos"
            ],
            "type": "string",
            "description": "Choose one operation per run. See the README for the required inputs for each operation.",
            "default": "creators-search"
          },
          "country": {
            "title": "Market",
            "enum": [
              "br",
              "de",
              "es",
              "fr",
              "gb",
              "id",
              "it",
              "jp",
              "mx",
              "my",
              "ph",
              "sg",
              "th",
              "us",
              "vn"
            ],
            "type": "string",
            "description": "Use the market in which the entity ID was found. Data coverage varies by market.",
            "default": "us"
          },
          "maxResults": {
            "title": "Maximum results",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Total result rows across this run. Stops pagination at this limit. Apify Free plan users receive up to 20 rows per run. Analytical results may contain nested report data.",
            "default": 10
          },
          "ids": {
            "title": "Entity IDs",
            "maxItems": 100,
            "type": "array",
            "description": "Required for details and related data. Paste IDs returned by a search in the selected market. Handles and URLs are not supported.",
            "items": {
              "type": "string"
            }
          },
          "include": {
            "title": "Additional detail sections",
            "type": "array",
            "description": "Optional sections for detail operations only. These do not fetch related lists such as comments or videos.",
            "items": {
              "type": "string",
              "enum": [
                "channel",
                "core",
                "portrait"
              ]
            }
          },
          "keyword": {
            "title": "Keyword",
            "type": "string",
            "description": "Search keyword\nApplies to: Search Creators."
          },
          "category": {
            "title": "Category",
            "type": "string",
            "description": "Optional creator content category ID. These IDs describe content interests and are different from numeric product category IDs. Omit this parameter to search without a category filter; use category_label from creator search results to obtain an ID for subsequent filtering.\n\nCreator category reference:\n\n| Category ID | Category name |\n| --- | --- |\n| creator_category_v20240616_8 | Shopping & Retail |\n| creator_category_v20240616_15 | Media & Entertainment |\n| creator_category_v20240616_10 | Beauty & Fashion |\n| creator_category_v20240616_14 | Personal Bloggers |\n| creator_category_v20240616_12 | Clothing & Accessories |\n| creator_category_v20240616_32 | Public Figures |\n| creator_category_v20240616_23 | Arts & Crafts |\n| creator_category_v20240616_17 | Sports & Fitness |\n| creator_category_v20240616_24 | Health & Wellness |\n| creator_category_v20240616_13 | Music & Dance |\n| creator_category_v20240616_9 | Home, Furniture & Appliances |\n| creator_category_v20240616_19 | Pets & Animals |\n| creator_category_v20240616_18 | Education |\n| creator_category_v20240616_11 | Food & Beverages |\n| creator_category_v20240616_31 | Automotive & Transportation |\n| creator_category_v20240616_5 | Electronics |\n| creator_category_v20240616_29 | Gaming |\n| creator_category_v20240616_30 | Professional Services |\n| creator_category_v20240616_16 | Parenting & Baby Care |\n| creator_category_v20240616_33 | Food & Cooking |\n| creator_category_v20240616_20 | Travel & Transportation |\n| creator_category_v20240616_27 | Finance & Investment |\n| creator_category_v20240616_2 | Machinery & Equipment |\n| creator_category_v20240616_21 | Brands |\n| creator_category_v20240616_25 | Consulting & Services |\n| creator_category_v20240616_4 | Real Estate |\n| creator_category_v20240616_28 | Government & Politics |\n| creator_category_v20240616_6 | Restaurants & Bars |\n| creator_category_v20240616_26 | IT & High Tech |\n| creator_category_v20240616_22 | Software & Apps |\n| creator_category_v20240616_3 | Livestreaming Agencies |\n| creator_category_v20240616_7 | Film & Production |\n| creator_category_v20240616_34 | Other |\nApplies to: Search Creators; Creator Agency Rankings.\nEnter a category ID or a category name from the reference table, such as Beauty & Personal Care."
          },
          "min_followers": {
            "title": "Min followers",
            "type": "number",
            "description": "Minimum follower count\nApplies to: Search Creators."
          },
          "max_followers": {
            "title": "Max followers",
            "type": "number",
            "description": "Maximum follower count\nApplies to: Search Creators."
          },
          "min_gmv_30d": {
            "title": "Min gmv 30d",
            "type": "number",
            "description": "Minimum 30-day GMV in USD\nApplies to: Search Creators."
          },
          "max_gmv_30d": {
            "title": "Max gmv 30d",
            "type": "number",
            "description": "Maximum 30-day GMV in USD\nApplies to: Search Creators."
          },
          "min_avg_views": {
            "title": "Min avg views",
            "type": "number",
            "description": "Minimum average view count\nApplies to: Search Creators."
          },
          "max_avg_views": {
            "title": "Max avg views",
            "type": "number",
            "description": "Maximum average view count\nApplies to: Search Creators."
          },
          "min_engagement": {
            "title": "Min engagement",
            "type": "number",
            "description": "Minimum engagement ratio, from 0 to 1 For example, 0.05 means 5%.\nApplies to: Search Creators."
          },
          "max_engagement": {
            "title": "Max engagement",
            "type": "number",
            "description": "Maximum engagement ratio, from 0 to 1 For example, 0.05 means 5%.\nApplies to: Search Creators."
          },
          "has_contact": {
            "title": "Has contact",
            "enum": [
              "any",
              "yes",
              "no"
            ],
            "type": "string",
            "description": "Whether to filter for creators with publicly available contact details, such as an email address or social account. Set true to require contact details; omit or set false to apply no contact filter.\nApplies to: Search Creators."
          },
          "sort": {
            "title": "Sort",
            "type": "string",
            "description": "Sort as field, field:asc or field:desc. A bare field uses descending order.\nApplies to: Search Creators; Creator Agency Rankings; Top-Selling Creators; Fastest-Growing Creators.\nAllowed fields — Search Creators: avg_views, engagement, follower_growth_7d, followers, gmv_30d, video_gmv_30d. Append :asc for ascending order."
          },
          "date": {
            "title": "Date",
            "type": "string",
            "description": "Reporting date in YYYYMMDD format, for example 20261013. Use with granularity to select the reporting period; data availability varies by date.\nApplies to: Top-Selling Creators; Fastest-Growing Creators. Use YYYY-MM-DD or YYYYMMDD."
          },
          "granularity": {
            "title": "Granularity",
            "enum": [
              "daily",
              "weekly",
              "monthly"
            ],
            "type": "string",
            "description": "Reporting period: daily, weekly or monthly. Numeric aliases 0, 1 and 2 are also accepted. Pair with date.\nApplies to: Top-Selling Creators; Fastest-Growing Creators."
          },
          "creator_category": {
            "title": "Creator category",
            "type": "string",
            "description": "Creator content category ID, such as creator_category_v20240616_8. See the category reference in Search Creators. This is different from a product category.\nApplies to: Top-Selling Creators; Fastest-Growing Creators.\nEnter a category ID or a category name from the reference table, such as Beauty & Personal Care."
          },
          "product_category": {
            "title": "Product category",
            "type": "string",
            "description": "Product category ID as a numeric string, such as 601450. See the category reference in Search Products; do not use creator content category IDs.\nApplies to: Top-Selling Creators; Fastest-Growing Creators.\nEnter a category ID or a category name from the reference table, such as Beauty & Personal Care."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}