{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Scraper — Products, Sales, Stock & Reviews", "description": "Scrape TikTok Shop products in bulk: price, discount, units sold, rating breakdown, stock per variant, reviews and shop stats. Search by keyword, store or category. Pay only for products delivered.", "version": "0.1", "x-build-id": "9TrFjAbmvosy714Sd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cazadores~tiktok-shop-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cazadores-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/cazadores~tiktok-shop-scraper/runs": { "post": { "operationId": "runs-sync-cazadores-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/cazadores~tiktok-shop-scraper/run-sync": { "post": { "operationId": "run-sync-cazadores-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": { "productUrls": { "title": "Product URLs or IDs", "type": "array", "description": "TikTok Shop product links in any format (tiktok.com/shop/pdp/..., shop.tiktok.com/..., vm.tiktok.com share links) or numeric product IDs.", "items": { "type": "string" } }, "searchKeywords": { "title": "Search keywords", "type": "array", "description": "Keywords such as 'led face mask'. Returns TikTok Shop's top ~30 products for each keyword (uses TikTok's public keyword pages; singular/plural variants are tried automatically).", "items": { "type": "string" } }, "storeUrls": { "title": "Store URLs", "type": "array", "description": "TikTok Shop store links (tiktok.com/shop/store//). Returns the store's featured products (up to 20) and the store stats.", "items": { "type": "string" } }, "categoryUrls": { "title": "Category URLs", "type": "array", "description": "TikTok Shop category links (tiktok.com/shop/c//). Paginated up to 'Max products per source'.", "items": { "type": "string" } }, "maxProductsPerSource": { "title": "Max products per keyword, store or category", "minimum": 1, "type": "integer", "description": "Keywords return at most ~30 and stores at most 20 featured products.", "default": 30 }, "scrapeProductDetails": { "title": "Full product details", "type": "boolean", "description": "On: open every product for full details (variants and stock, rating breakdown, reviews, shipping, specifications). Off: return the quick listing data only (title, price, sold count, rating) at a lower price. Product URLs are always scraped in full.", "default": true }, "maxReviewsPerProduct": { "title": "Reviews per product", "minimum": 0, "type": "integer", "description": "Top reviews shown on the product page (usually up to 3-10).", "default": 10 }, "includeVariants": { "title": "Include variants (SKUs) and stock", "type": "boolean", "description": "Price, stock and options of every variant.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Products scraped in parallel.", "default": 10 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Default (Apify proxy, no group) uses datacenter IPs and automatically retries with US residential IPs if TikTok blocks. Included in the price.", "default": { "useApifyProxy": true } }, "failIfSuccessRateBelow": { "title": "Fail run if success rate is below (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "For monitoring: mark the run as FAILED when fewer than this % of products succeed (0 = off).", "default": 0 } } }, "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 } } } } } } } } } }