{
  "openapi": "3.0.1",
  "info": {
    "title": "TikTok Shop Scraper | Products, Sellers, Reviews & Videos",
    "description": "Scrape TikTok Shop US products by keyword or URL: price, discount, rating, units sold, SKU stock, variants, seller analytics, 1-5 star review histogram and registered business name - plus the TikTok video selling each listing (views, likes, creator). 79 fields, incremental monitoring.",
    "version": "0.1",
    "x-build-id": "5qkzdrTaNOv4XhSvE"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/corvuslab~tiktok-shop-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-corvuslab-tiktok-shop-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/corvuslab~tiktok-shop-scraper/runs": {
      "post": {
        "operationId": "runs-sync-corvuslab-tiktok-shop-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/corvuslab~tiktok-shop-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-corvuslab-tiktok-shop-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",
        "properties": {
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "Keywords to search TikTok Shop for, one per line (e.g. `lash serum`, `stanley cup`). Each term is paginated separately and gets an even share of `maxResults`, so no single broad keyword can use up the whole run. Leave empty when you only want the products or shops listed below.",
            "items": {
              "type": "string"
            }
          },
          "productUrls": {
            "title": "Product or shop URLs",
            "type": "array",
            "description": "Scrape specific products or shops instead of (or as well as) searching. Accepts product pages (`shop.tiktok.com/us/pdp/.../1729...`) and shop pages (`shop.tiktok.com/us/store/.../7495...`). A product URL always returns full details; a shop URL returns one seller-summary row for that shop, not its catalogue.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxResults": {
            "title": "Max products",
            "minimum": 1,
            "maximum": 20000,
            "type": "integer",
            "description": "Stop after this many products in total. With several search terms the budget is split evenly between them, and any share a term cannot fill is passed to the ones after it — so two terms at 40 give roughly 20 each, but if the first only finds 5 the second may return 35. Keep it small on the first run — you are charged per product returned.",
            "default": 40
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "relevance",
              "best sellers",
              "price low to high",
              "price high to low",
              "newest"
            ],
            "type": "string",
            "description": "How TikTok Shop should rank the results. **Best sellers** is the one to use for product research — it surfaces proven movers instead of new listings.",
            "default": "relevance"
          },
          "minPrice": {
            "title": "Min price",
            "minimum": 0,
            "type": "integer",
            "description": "Only return products priced at or above this (in the storefront's currency, USD)."
          },
          "maxPrice": {
            "title": "Max price",
            "minimum": 0,
            "type": "integer",
            "description": "Only return products priced at or below this."
          },
          "minRating": {
            "title": "Min rating",
            "enum": [
              "3",
              "4",
              "5"
            ],
            "type": "string",
            "description": "Only return products rated at or above this. Products with no rating yet are excluded when this is set."
          },
          "minSoldCount": {
            "title": "Min units sold",
            "minimum": 0,
            "type": "integer",
            "description": "Only return products that have sold at least this many units — the fastest way to filter out listings with no traction."
          },
          "dealsOnly": {
            "title": "Discounted products only",
            "type": "boolean",
            "description": "Restrict the search to products currently running a promotion.",
            "default": false
          },
          "categoryIds": {
            "title": "Category IDs",
            "type": "array",
            "description": "Bias a search towards specific TikTok Shop categories. Note this is a soft signal: TikTok Shop re-ranks results towards the category rather than excluding everything else, so treat it as a hint, not a filter. IDs appear in the `categoryId` field of any result and in category URLs (`/c/makeup/848648` → `848648`).",
            "items": {
              "type": "string"
            }
          },
          "strictFilters": {
            "title": "Enforce filters exactly",
            "type": "boolean",
            "description": "Drop products that fall outside your price / rating / units-sold bounds. Turn this off to receive everything TikTok Shop ranks for the search, including near-misses and the promoted card at the top of each page.",
            "default": true
          },
          "includeProductDetails": {
            "title": "Fetch full product details",
            "type": "boolean",
            "description": "Adds the full description, every product image, all variants and SKUs with live stock, specifications, shipping estimate, category path, seller statistics, the star-rating breakdown, recent reviews and the registered business name/address. Costs one extra request per product, so it is slower.",
            "default": false
          },
          "includeShopStats": {
            "title": "Add seller statistics",
            "type": "boolean",
            "description": "Attach the seller's total units sold, follower count, product count, video count and review count to every product — without fetching the whole product page. Ignored when full product details are on (those already include it).",
            "default": false
          },
          "compact": {
            "title": "Compact output (AI mode)",
            "type": "boolean",
            "description": "Return only the core decision fields (title, price, rating, reviews, units sold, shop, image, URL). Ideal for LLM pipelines and spreadsheets.",
            "default": false
          },
          "excludeEmptyFields": {
            "title": "Drop empty fields",
            "type": "boolean",
            "description": "Omit fields that are null or empty from each record, producing a smaller payload.",
            "default": false
          },
          "descriptionFormat": {
            "title": "Description format",
            "enum": [
              "all",
              "text",
              "html",
              "markdown"
            ],
            "type": "string",
            "description": "Which description variants to include when full product details are on.",
            "default": "all"
          },
          "descriptionMaxLength": {
            "title": "Truncate descriptions to",
            "minimum": 1,
            "type": "integer",
            "description": "Cut descriptions at this many characters. Leave empty for the full text."
          },
          "incrementalMode": {
            "title": "Incremental mode (monitor changes)",
            "type": "boolean",
            "description": "Remember what the previous run saw and label every product `NEW`, `UPDATED` or `UNCHANGED`. A product counts as changed when its title, price, rating, review count or units sold moves. Unchanged products are skipped and cost nothing, so a daily price watch only pays for what actually moved.",
            "default": false
          },
          "stateKey": {
            "title": "Monitor name",
            "type": "string",
            "description": "Name this monitor so several scheduled searches can track different product sets independently. Leave empty to derive one from the search settings."
          },
          "emitUnchanged": {
            "title": "Also return unchanged products",
            "type": "boolean",
            "description": "Include `UNCHANGED` products in the dataset. Off by default — that is what makes incremental runs cheap.",
            "default": false
          },
          "emitExpired": {
            "title": "Report delisted products",
            "type": "boolean",
            "description": "Emit an `EXPIRED` record for products seen in a previous run that are gone from this one.",
            "default": false
          },
          "telegramToken": {
            "title": "💬 Telegram bot token",
            "type": "string",
            "description": "Bot token from @BotFather."
          },
          "telegramChatId": {
            "title": "🆔 Telegram chat ID",
            "type": "string",
            "description": "Chat or channel ID, e.g. \"-100123456789\" or \"@yourchannel\"."
          },
          "slackWebhookUrl": {
            "title": "💼 Slack webhook URL",
            "type": "string",
            "description": "Slack incoming-webhook URL."
          },
          "discordWebhookUrl": {
            "title": "🎮 Discord webhook URL",
            "type": "string",
            "description": "Discord incoming-webhook URL."
          },
          "webhookUrl": {
            "title": "🪝 Webhook URL",
            "type": "string",
            "description": "Any HTTPS endpoint. Receives a JSON POST with the new and updated products — works with n8n, Make and Zapier."
          },
          "webhookHeaders": {
            "title": "🧾 Webhook headers",
            "type": "object",
            "description": "Extra headers for the webhook request, e.g. {\"Authorization\": \"Bearer xyz\"}."
          },
          "notificationLimit": {
            "title": "🔢 Products per notification",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "How many products to include in each notification message.",
            "default": 5
          },
          "notionApiKey": {
            "title": "📓 Notion integration token",
            "type": "string",
            "description": "Create an internal integration at notion.so/my-integrations, copy its Internal Integration Secret (starts with 'ntn_'), then open the target database → ⋯ → Connections → and connect that integration. Without that last step Notion returns 'object_not_found'."
          },
          "notionDatabaseId": {
            "title": "🗂️ Notion database ID or URL",
            "type": "string",
            "description": "Paste the database's URL or its 32-character ID. Every product becomes one page in that database, with its main image as the page cover. The database can start completely empty — the columns are created for you on the first run."
          },
          "notionCreateProperties": {
            "title": "🛠️ Create missing Notion columns",
            "type": "boolean",
            "description": "Add any columns the target database is missing (with the right Notion type) on the first run. Turn this off to write only into columns you created yourself — fields with no matching column are then skipped.",
            "default": true
          },
          "clayWebhookUrl": {
            "title": "🧱 Clay webhook URL",
            "type": "string",
            "description": "Optional. Paste the webhook URL of a Clay table. In Clay: open the table → Actions → Import → Import data from webhook, then copy the generated URL. Each product arrives as its own row; nested columns (skus, variants, reviews, specifications) arrive as JSON text a Clay formula column can parse."
          },
          "clayAuthToken": {
            "title": "🔑 Clay webhook auth token",
            "type": "string",
            "description": "Optional. Only needed if you enabled an authentication token on the Clay webhook source. Sent as the 'x-clay-webhook-auth' header."
          },
          "detailConcurrency": {
            "title": "Detail concurrency",
            "minimum": 1,
            "maximum": 12,
            "type": "integer",
            "description": "How many product pages to fetch in parallel when full details are on.",
            "default": 6
          },
          "maxRequestRetries": {
            "title": "Max request retries",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "How many times to retry a failed request before giving up on it.",
            "default": 3
          },
          "ignoreUrlFailures": {
            "title": "Skip unusable URLs",
            "type": "boolean",
            "description": "Warn and continue when a start URL cannot be interpreted, instead of failing the run.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "TikTok Shop only serves its US storefront, so the run must exit from a US IP. The default (Apify Proxy, country US) is what you want — changing the country returns no products.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyCountry": "US"
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}