{
  "openapi": "3.0.1",
  "info": {
    "title": "TikTok Shop Top Products: Revenue, Units & Video/LIVE Split",
    "description": "Rank TikTok Shop best sellers by revenue or units sold in 15 markets: a whole market, category, search term, shop, creator or past month. Each row has revenue split into video, LIVE and shop window, 30-day growth, commission, creator counts and 1-90 day sales, in USD. JSON, CSV or API.",
    "version": "0.0",
    "x-build-id": "BDDYn7mSKAgb9oFKY"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/memo23~tiktok-shop-top-products/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-memo23-tiktok-shop-top-products",
        "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~tiktok-shop-top-products/runs": {
      "post": {
        "operationId": "runs-sync-memo23-tiktok-shop-top-products",
        "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~tiktok-shop-top-products/run-sync": {
      "post": {
        "operationId": "run-sync-memo23-tiktok-shop-top-products",
        "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": {
          "market": {
            "title": "Market",
            "enum": [
              "US",
              "GB",
              "DE",
              "FR",
              "IT",
              "ES",
              "BR",
              "JP",
              "MX",
              "ID",
              "TH",
              "VN",
              "PH",
              "MY",
              "SG"
            ],
            "type": "string",
            "description": "Which TikTok Shop country to rank, for example US or GB (default US). Money columns are converted to US dollars for all 15 countries.",
            "default": "US"
          },
          "period": {
            "title": "Sales period",
            "enum": [
              "lastDay",
              "last7Days",
              "last30Days",
              "allTime"
            ],
            "type": "string",
            "description": "Window for revenue and units sold. Every row also carries the 1, 7, 30 and 90-day and lifetime figures.",
            "default": "last30Days"
          },
          "sortBy": {
            "title": "Rank by",
            "enum": [
              "revenue",
              "unitsSold",
              "price"
            ],
            "type": "string",
            "description": "Highest first.",
            "default": "revenue"
          },
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "Products whose title contains every word of the term, for example <b>air fryer</b>, <b>lip oil</b>, <b>creatine</b>. Leave all inputs empty for the top products of the whole market.",
            "items": {
              "type": "string"
            }
          },
          "categories": {
            "title": "Categories",
            "type": "array",
            "description": "Top products of a TikTok Shop category: Beauty & Personal Care, Health, Household Appliances, Home Supplies, Kitchenware, Womenswear & Underwear, Menswear & Underwear, Phones & Electronics, Sports & Outdoor, Toys & Hobbies, Pet Supplies, Baby & Maternity, Food & Beverages, Fashion Accessories, Textiles & Soft Furnishings, Automotive & Motorcycle, Tools & Hardware, Home Improvement, Computers & Office Equipment, Luggage & Bags, Shoes, Furniture, Books, Magazines & Audio, Kids' Fashion, Jewelry Accessories & Derivatives, Collectibles, Pre-Owned, Muslim Fashion. A numeric category id works too.",
            "items": {
              "type": "string"
            }
          },
          "shops": {
            "title": "Shops",
            "type": "array",
            "description": "Shops to rank: a store link such as https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079, or just the numeric shop id. Returns that shop's products, ranked by Rank by.",
            "items": {
              "type": "string"
            }
          },
          "creators": {
            "title": "Creators",
            "type": "array",
            "description": "Creators to look up: a TikTok @username, a profile link such as https://www.tiktok.com/@dealswithty, or a numeric user id. Returns the products each one promotes, ranked by Rank by.",
            "items": {
              "type": "string"
            }
          },
          "pastMonth": {
            "title": "Past month",
            "pattern": "^$|^\\d{4}-\\d{2}$",
            "type": "string",
            "description": "Optional. A finished month such as <b>2026-10</b>: that month's best sellers by units sold, for the market or the categories above. Search terms, shops and creators keep the sales period."
          },
          "maxProductsPerSource": {
            "title": "Products per input",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Upper limit for each search term, category, shop or creator (or for the whole-market list). Duplicates across inputs are delivered once.",
            "default": 50
          },
          "minPrice": {
            "title": "Minimum price (USD)",
            "minimum": 0,
            "type": "integer",
            "description": "Average selling price. Leave empty for no floor."
          },
          "maxPrice": {
            "title": "Maximum price (USD)",
            "minimum": 0,
            "type": "integer",
            "description": "Leave empty for no ceiling."
          },
          "minRevenue": {
            "title": "Minimum revenue (USD)",
            "minimum": 0,
            "type": "integer",
            "description": "Revenue in the sales period."
          },
          "minUnitsSold": {
            "title": "Minimum units sold",
            "minimum": 0,
            "type": "integer",
            "description": "Units sold in the sales period."
          },
          "minCommissionPercent": {
            "title": "Minimum creator commission (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Affiliate commission the seller offers creators."
          },
          "minRating": {
            "title": "Minimum rating",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "1 to 5."
          },
          "sellerType": {
            "title": "Seller type",
            "enum": [
              "any",
              "local",
              "crossBorder"
            ],
            "type": "string",
            "description": "Local sellers or cross-border sellers.",
            "default": "any"
          },
          "mainChannel": {
            "title": "Main sales channel",
            "enum": [
              "any",
              "video",
              "live"
            ],
            "type": "string",
            "description": "Products that sell mainly through videos or mainly through LIVE streams.",
            "default": "any"
          },
          "freeShippingOnly": {
            "title": "Free shipping only",
            "type": "boolean",
            "description": "Only products with free shipping.",
            "default": false
          },
          "risingOnly": {
            "title": "Rising sales only",
            "type": "boolean",
            "description": "Only products whose sales went up over the last 7 days.",
            "default": false
          },
          "salesHistory": {
            "title": "Daily sales history",
            "enum": [
              "off",
              "7",
              "30",
              "90"
            ],
            "type": "string",
            "description": "Adds a <code>salesHistory</code> list to every product: one entry per day with that day's units sold and revenue, the running totals, average price and how many creators, videos and lives were selling it. Charged per 10 days delivered ($0.003), so 30 days cost up to $0.009 per product. Needs a paid Apify plan. Available from 3 December 2026; before that, rows come without it. Default: off.",
            "default": "off"
          },
          "includeSuspectedPlaceholders": {
            "title": "Keep placeholder listings",
            "type": "boolean",
            "description": "Affiliate samples, \"not for sale\" gifts and live-auction slots carry placeholder prices and inflate revenue rankings, so they are skipped. Turn on to keep them, marked with suspectReason.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}