{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Product Scraper", "description": "Scrape TikTok Shop US products by keyword, category, or URL — title, price, rating, sold count, seller, and images as clean JSON. Reads the real US storefront a shopper sees, with slider-captcha handling built in. Great for product research and trend spotting. Pay only for results.", "version": "1.0", "x-build-id": "s7TZklWnxB9pixfx8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axlymxp~tiktok-shop-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axlymxp-tiktok-shop-product-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/axlymxp~tiktok-shop-product-scraper/runs": { "post": { "operationId": "runs-sync-axlymxp-tiktok-shop-product-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/axlymxp~tiktok-shop-product-scraper/run-sync": { "post": { "operationId": "run-sync-axlymxp-tiktok-shop-product-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": { "searchQueries": { "title": "Search queries", "type": "array", "description": "Keywords to search on the TikTok Shop US storefront (one search per keyword). Example: \"wireless earbuds\", \"skincare\".", "default": [], "items": { "type": "string" } }, "categoryUrls": { "title": "Category / listing URLs", "type": "array", "description": "Direct TikTok Shop listing URLs (category, mall or hashtag pages). Products are harvested by scrolling the page.", "default": [], "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Direct TikTok Shop product URLs (or bare 19-digit product IDs) to fetch full detail for. These are always fetched with full product detail.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max items (total)", "minimum": 1, "type": "integer", "description": "Global cap across all queries, categories and URLs. The run stops once this many products are pushed. You are billed per result.", "default": 100 }, "maxItemsPerQuery": { "title": "Max items per query", "minimum": 1, "type": "integer", "description": "Cap on products harvested from a single search keyword or category URL (before the global cap applies).", "default": 100 }, "fetchProductDetails": { "title": "Fetch full product detail", "type": "boolean", "description": "Open each product's page for the full detail payload (seller, description, category, more images). Higher quality but slower and more captcha-exposed. Leave off for fast list scraping.", "default": false }, "solveCaptcha": { "title": "Auto-solve slider captcha", "type": "boolean", "description": "Automatically solve the TikTok Shop OEC \"Lucifer\" slider captcha (computer-vision gap detection) when it appears. When off, only a cheap page-reload retry is used.", "default": true }, "proxyProvider": { "title": "Proxy provider", "enum": [ "apify", "massive", "zyte" ], "type": "string", "description": "Residential/unblocker egress. 'apify' (default) uses your Apify Proxy RESIDENTIAL allocation; 'massive' uses a shared Massive pool; 'zyte' routes through the Zyte API anti-ban proxy (set the ZYTE_API_KEY environment variable). IMPORTANT: TikTok's captcha flags shared/overused residential IPs — for reliable results use a premium US residential/mobile proxy or the Zyte unblocker. The US storefront requires a US IP.", "default": "apify" }, "proxyCountry": { "title": "Proxy country", "type": "string", "description": "Residential exit-IP country (ISO-3166 alpha-2). Keep 'US' for the US storefront.", "default": "US" }, "headless": { "title": "Headless browser", "type": "boolean", "description": "Run the stealth browser headless. Leave true for production runs on the platform.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "The TikTok Shop US storefront is served only to US IP addresses, so US Residential proxies are used by default. A US residential IP is strongly recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "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 } } }, "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 } } } } } } } } } }