{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Scraper", "description": "Scrape TikTok Shop products by URL, ID, keyword, or hashtag. Returns title, price, sold count, ratings, reviews, seller info, variants, images, launch date, and creator-promoter count.", "version": "0.0", "x-build-id": "vqfFOnryr12RqKJ4v" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lurkapi~tiktok-shop-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lurkapi-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/lurkapi~tiktok-shop-scraper/runs": { "post": { "operationId": "runs-sync-lurkapi-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/lurkapi~tiktok-shop-scraper/run-sync": { "post": { "operationId": "run-sync-lurkapi-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": { "keywords": { "title": "Keyword search", "type": "array", "description": "Search the TikTok Shop catalog for each term and scrape the top matching products. Works like an Amazon Best Sellers list for that search (e.g. vitamin c serum). One keyword per line.", "items": { "type": "string" } }, "urls": { "title": "Product or shop URLs", "type": "array", "description": "Scrape specific products or shops by link: product URLs (tiktok.com/shop/pdp/...), shop URLs with a numeric ID (tiktok.com/shop/s/SHOP_ID), or short links (vm.tiktok.com/...), all auto-detected. @username/shop links aren't supported; use a URL with the numeric shop ID.", "items": { "type": "string" } }, "productIds": { "title": "Product IDs", "type": "array", "description": "Scrape specific products by ID. The product ID is the 18 to 19 digit number in any product URL (e.g. 1731349100249977343). One per line.", "items": { "type": "string" } }, "shopIds": { "title": "Shop IDs", "type": "array", "description": "Scrape every product a shop lists, by its numeric shop ID. One per line.", "items": { "type": "string" } }, "maxProductsPerSource": { "title": "Max products per source", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on products returned per keyword or shop. URL and product ID inputs always return one each, regardless of this cap.", "default": 50 }, "country": { "title": "TikTok Shop region", "enum": [ "US" ], "type": "string", "description": "The regional storefront to scrape. The United States is the only region available today. The UK, France, and Southeast Asian markets are on the roadmap.", "default": "US" }, "includeReviews": { "title": "Extra reviews per product ($)", "type": "boolean", "description": "Up to 5 reviews per product are always included free. Turn on only to pull more than 5. Each review past the 5th is billed.", "default": false }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 1, "maximum": 600, "type": "integer", "description": "How many reviews to return per product when 'Extra reviews' is on. The first 5 are free, the rest are billed.", "default": 5 }, "reviewsSortBy": { "title": "Reviews sort order", "enum": [ "newest", "recommended" ], "type": "string", "description": "How to order the reviews returned. 'newest' picks the most recent first; 'recommended' uses TikTok's relevance ranking (tends to surface higher-quality reviews with photos).", "default": "newest" }, "reviewsStarRating": { "title": "Reviews star filter", "minimum": 0, "maximum": 5, "type": "integer", "description": "Limit reviews to one specific star rating (1-5). Use 0 (default) to disable the filter and return reviews of any star rating.", "default": 0 }, "includeCreatorCount": { "title": "Creator count ($)", "type": "boolean", "description": "Adds a creatorCount field showing how many TikTok creators are promoting each product. A strong momentum signal for spotting rising winners.", "default": false }, "includeFirstSeen": { "title": "First-seen date", "type": "boolean", "description": "Adds a firstSeen field: the date the product was first seen active. Use it as a rough launch-date estimate. Free. Adds one request per product, so runs take slightly longer.", "default": false }, "outputTitle": { "title": "Output: title", "type": "boolean", "description": "Include the product title.", "default": true }, "outputDescription": { "title": "Output: description", "type": "boolean", "description": "Include the product description.", "default": true }, "outputCurrentPrice": { "title": "Output: current price", "type": "boolean", "description": "Include the discounted current price.", "default": true }, "outputOriginalPrice": { "title": "Output: original price", "type": "boolean", "description": "Include the pre-discount list price.", "default": true }, "outputDiscountPercent": { "title": "Output: discount %", "type": "boolean", "description": "Include the percent discount.", "default": true }, "outputCurrency": { "title": "Output: currency", "type": "boolean", "description": "Include the price currency code (USD, GBP, etc.).", "default": true }, "outputRating": { "title": "Output: rating", "type": "boolean", "description": "Include the average product rating (0-5).", "default": true }, "outputReviewCount": { "title": "Output: review count", "type": "boolean", "description": "Include the total number of reviews.", "default": true }, "outputSoldCount": { "title": "Output: sold count", "type": "boolean", "description": "Include the lifetime sold count.", "default": true }, "outputSellerId": { "title": "Output: seller ID", "type": "boolean", "description": "Include the seller's TikTok Shop ID.", "default": true }, "outputSellerName": { "title": "Output: seller name", "type": "boolean", "description": "Include the seller's shop name.", "default": true }, "outputSellerFollowers": { "title": "Output: seller followers", "type": "boolean", "description": "Include the seller's follower count.", "default": true }, "outputSellerRating": { "title": "Output: seller rating", "type": "boolean", "description": "Include the seller's overall shop rating.", "default": true }, "outputSellerSold": { "title": "Output: seller sold count", "type": "boolean", "description": "Include the seller's shop-wide sold count.", "default": true }, "outputSellerResponseRatePct": { "title": "Output: seller response rate %", "type": "boolean", "description": "Include the seller's customer-message response rate.", "default": true }, "outputSellerShipsWithinDays": { "title": "Output: seller ships-within days", "type": "boolean", "description": "Include the seller's typical ship-within days. Only available when the desktop fallback handles the product (DOM-only field).", "default": true }, "outputSellerPositiveFeedbackPct": { "title": "Output: seller positive feedback %", "type": "boolean", "description": "Include the seller's positive-feedback percentage.", "default": true }, "outputBrand": { "title": "Output: brand", "type": "boolean", "description": "Include the product brand name.", "default": true }, "outputCategoryPath": { "title": "Output: category path", "type": "boolean", "description": "Include the breadcrumb category path.", "default": true }, "outputImageUrls": { "title": "Output: image URLs", "type": "boolean", "description": "Include the product image URLs.", "default": true }, "outputShippingOrigin": { "title": "Output: shipping origin", "type": "boolean", "description": "Include the shipping origin country/region.", "default": true }, "outputVariants": { "title": "Output: variants / SKUs", "type": "boolean", "description": "Include the array of variants/SKUs with sizes, colors, and per-SKU prices.", "default": true }, "outputSellerProductCount": { "title": "Output: seller product count", "type": "boolean", "description": "Include how many products the seller currently lists.", "default": true }, "outputSellerReviewCount": { "title": "Output: seller review count", "type": "boolean", "description": "Include the seller's shop-wide review count.", "default": true }, "outputSellerVideoCount": { "title": "Output: seller video count", "type": "boolean", "description": "Include how many videos promote the seller's shop.", "default": true }, "outputSellerUrl": { "title": "Output: seller URL", "type": "boolean", "description": "Include the seller's storefront URL.", "default": true }, "outputSellerIsOfficial": { "title": "Output: official shop flag", "type": "boolean", "description": "Include whether the seller is an official TikTok Shop.", "default": true }, "outputBusinessName": { "title": "Output: business name", "type": "boolean", "description": "Include the seller's registered business name.", "default": true } } }, "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 } } } } } } } } } }