{
  "openapi": "3.0.1",
  "info": {
    "title": "TikTok Shop Scraper: US Products, Prices, Units Sold, Stock",
    "description": "TikTok Shop scraper for the US store. Search by keyword, product link or shop link and get price, discount, rating, reviews, units sold, shop stats and every variant with its stock. No login, no cookie, no browser. $6 per 1,000 products.",
    "version": "0.1",
    "x-build-id": "q308Vtxck6oCqwSS0"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/themineworks~tiktok-shop-products/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-themineworks-tiktok-shop-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/themineworks~tiktok-shop-products/runs": {
      "post": {
        "operationId": "runs-sync-themineworks-tiktok-shop-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/themineworks~tiktok-shop-products/run-sync": {
      "post": {
        "operationId": "run-sync-themineworks-tiktok-shop-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": {
          "searchKeywords": {
            "title": "Search keywords",
            "type": "array",
            "description": "Product keywords to search on TikTok Shop US, for example \"wireless earbuds\" or \"protein powder\". Each keyword returns its search results in order, usually 60 to 120 products before TikTok's list ends. No login needed. TikTok Shop's UK website has no keyword search, so with Marketplace set to United Kingdom use category links or product links instead.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "productUrls": {
            "title": "Product links or IDs",
            "type": "array",
            "description": "TikTok Shop product links (shop.tiktok.com/us/pdp/..., shop.tiktok.com/gb/pdp/..., tiktok.com/view/product/..., tiktok.com/shop/pdp/...) or bare product IDs. One row per product with every variant, its stock, categories, specifications and shop stats. A link that names /gb/ is read from the UK shop; bare IDs use the Marketplace below.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "shopUrls": {
            "title": "Store links",
            "type": "array",
            "description": "TikTok Shop store links, for example https://shop.tiktok.com/us/store/jbl/7494161853719414088 or https://www.tiktok.com/shop/store/jbl/7494161853719414088. Returns the store's catalogue. A handle (@name) also works here when a store has exactly that name; to get the products a creator promotes in their videos, use Creator handles instead. US stores only: TikTok Shop's UK website does not show store pages.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "categoryUrls": {
            "title": "Category links",
            "type": "array",
            "description": "TikTok Shop category links, for example https://shop.tiktok.com/us/c/health/700645 or https://www.tiktok.com/shop/c/health/700645, or a bare category ID. Returns the category's products in TikTok's order, up to Max products. UK category links (shop.tiktok.com/gb/c/...) work too.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "creatorHandles": {
            "title": "Creator handles (products they promote)",
            "type": "array",
            "description": "TikTok creators, as @name, name or a profile link such as https://www.tiktok.com/@name. Returns the TikTok Shop products the creator links in their recent videos, one row per product with the videos that tag it and their plays, plus the full product page (price, units sold, rating, stock). TikTok shows the Shop tab itself only to logged in visitors, so this reads the products from the creator's public videos.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "maxProducts": {
            "title": "Max products per keyword, store, category or creator",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Upper limit of products for each keyword, store, category and creator. You pay only for products delivered. A product that already came up for an earlier keyword, store or category in the same run is skipped, not charged twice.",
            "default": 5
          },
          "region": {
            "title": "Marketplace",
            "enum": [
              "US",
              "GB"
            ],
            "type": "string",
            "description": "TikTok Shop marketplace for keywords, bare product IDs and bare category IDs. Links that name a country (/us/ or /gb/) always use that country. United Kingdom pages are read over UK residential proxy, and the UK website has no keyword search. Other marketplaces (Southeast Asia, Japan, Mexico, Brazil, EU) show logged out visitors a slide CAPTCHA or no web shop, so they are not offered.",
            "default": "US"
          },
          "maxVideosPerCreator": {
            "title": "Videos to scan per creator",
            "minimum": 15,
            "maximum": 300,
            "type": "integer",
            "description": "How many of each creator's most recent videos to read for product links (15 per page). More videos find more products and take a little longer. Only used with Creator handles.",
            "default": 30
          },
          "includeDetails": {
            "title": "Add full product details to search and store results",
            "type": "boolean",
            "description": "Opens each product's own page too, adding every variant with its price and stock, total stock, categories, specifications, description, shipping and shop stats. Slower, same price per product. Product links always include these details.",
            "default": false
          },
          "includeReviews": {
            "title": "Add reviews and the star breakdown",
            "type": "boolean",
            "description": "Adds the reviews TikTok Shop shows on each product's page (usually the first 3: text, stars, date, variant, photos, verified purchase) and how many 5, 4, 3, 2 and 1 star reviews the product has. Opens each product's page, so full details come with it. Same price per product.",
            "default": false
          },
          "includeVideos": {
            "title": "Add the TikTok videos promoting each product",
            "type": "boolean",
            "description": "Adds the TikTok videos TikTok Shop lists on each product's page (usually up to 20): video link, caption, creator, plays, likes, post date and whether the creator earns commission. Opens each product's page, so full details come with it. Same price per product.",
            "default": false
          },
          "proxyConfig": {
            "title": "Proxy configuration (not used)",
            "type": "object",
            "description": "Not used. The actor always reads TikTok Shop over Apify datacenter proxy, which TikTok Shop serves without a login. You are not charged for proxy.",
            "default": {
              "useApifyProxy": true
            }
          },
          "sessionCookie": {
            "title": "TikTok session cookie (not used)",
            "type": "string",
            "description": "Not used and not needed. Search, product and store pages are read without any login or cookie. Leave this empty."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}