{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Scraper — Products, Prices & Sales", "description": "Scrape TikTok Shop US products by keyword, shop, category or product URL: price, discount, units sold, rating, shop, variants with stock, shipping and top reviews. No login.", "version": "0.1", "x-build-id": "rTxLRnuMeBgV4dcGA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~tiktok-shop-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-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/tortuga~tiktok-shop-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-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/tortuga~tiktok-shop-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-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 on TikTok Shop US, one per line (e.g. \"bluetooth speaker\", \"lip gloss\"). Each term is paginated automatically: 25-30 products per request; TikTok's web shop stops after about 150 products per keyword.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "TikTok Shop US URLs instead of (or in addition to) search terms: product pages (https://shop.tiktok.com/us/pdp//, www.tiktok.com/shop/pdp/... or a bare product id; always returned with full details), shop pages (https://shop.tiktok.com/us/store//, all products of the shop), category pages (https://shop.tiktok.com/us/c//) and keyword pages (/us/k/, /us/s?q=; run as a search).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many products in total (across all search terms and URLs). Keeps cost predictable.", "default": 100 }, "includeDetails": { "title": "Include product details", "type": "boolean", "description": "Also open every product page to get all variants / SKUs with their own price and stock, shipping fee and delivery estimate, the shop profile (rating, followers, products sold, response scores), description, specifications, all images, category path, rating breakdown and the top reviews TikTok shows on the page (up to 3). One extra request and one extra `detail` charge per product (see pricing).", "default": false }, "sortBy": { "title": "Sort search results", "enum": [ "relevance", "best_sellers", "price_low", "price_high", "newest" ], "type": "string", "description": "Order of search-term results, as in TikTok Shop's own \"Sort by\" menu. TikTok sometimes answers sorted searches with a short unsorted list; the actor asks again and, if needed, falls back to relevance order (listed in the run's SUMMARY as sortFallback). Does not apply to shop and category URLs.", "default": "relevance" }, "maxPagesPerSource": { "title": "Max pages per search, shop or category", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many result pages to load per search term (25-30 products each), shop (20 each) or category URL (category pages show 10-15 products each; further pages are the category's subcategories).", "default": 10 }, "includeSubcategories": { "title": "Follow subcategories", "type": "boolean", "description": "For category URLs: TikTok's public category page lists only 10-15 products, so the actor continues with the category's subcategories (each another 10-15 products) until Max pages or Max items is reached.", "default": true }, "onlyNewOrChanged": { "title": "Only new or changed items", "type": "boolean", "description": "Remember what earlier runs of this search returned and output only new items or items whose price/status changed. Use with a Schedule; unchanged items are not charged. With this on, Max items is the number of products checked each run (the watched window, e.g. the first 50 search results), so a run never digs deeper than the first one. Price, crossed-out price and the lowest / highest variant price are compared; product pages are only opened for new or changed products.", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name for this watch, so several schedules on the same search stay separate; defaults to a key derived from the search input." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify's default datacenter proxy works and is the cheapest choice (no per-request proxy fee). Pages that come back as TikTok's 'Security Check' captcha (about 1 in 20 product pages) are retried automatically on a new IP. Residential proxies are not needed and were not more reliable in tests.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }