{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Scraper - Products, Sales & Shops", "description": "Scrape TikTok Shop (US) products by keyword, store, category or product link. Get prices and discounts, sold counts, ratings, reviews, shops, brands, variants with stock, shipping and the TikTok video that sells each product. No login.", "version": "0.1", "x-build-id": "Cl2NiVf1Ad3afr5xw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jmlp~tiktok-shop-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jmlp-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/jmlp~tiktok-shop-scraper/runs": { "post": { "operationId": "runs-sync-jmlp-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/jmlp~tiktok-shop-scraper/run-sync": { "post": { "operationId": "run-sync-jmlp-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": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "What you would type into TikTok Shop's search, one per line: 'phone case', 'stanley cup', 'led face mask'. Each search pages through its results until TikTok has no more.", "items": { "type": "string" } }, "startUrls": { "title": "TikTok Shop links", "type": "array", "description": "Paste links straight from your browser: a product (shop.tiktok.com/us/pdp/...), a store (shop.tiktok.com/us/store/...) for all its products, a category (shop.tiktok.com/us/c/...) or a keyword page (shop.tiktok.com/us/k/...). www.tiktok.com/shop links, share links and bare product ids work too.", "items": { "type": "string" } }, "maxProducts": { "title": "Max products", "type": "integer", "description": "Stop after this many unique products across every search and link. Caps both runtime and cost. Empty means every product found." }, "maxProductsPerSearch": { "title": "Max products per search or link", "type": "integer", "description": "Cap each search, store or category separately, so one big search does not use up 'Max products' alone." }, "scrapeProductDetails": { "title": "Scrape product details", "type": "boolean", "description": "Open each product's page for the description, all images, specifications, every variant with its price and stock, the category path, shipping, the rating breakdown, top reviews and the seller's location. One extra request per product. Product links always get them.", "default": false }, "includeSubcategories": { "title": "Include subcategories", "type": "boolean", "description": "For a category link, also scrape each of its subcategories, all the way down. TikTok shows the first products of each category, so this is what makes a category link go deep.", "default": true }, "maxConcurrency": { "title": "Requests at once", "type": "integer", "description": "How many pages to load in parallel, 1 to 20, each on its own exit IP.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "TikTok Shop's US pages answer US visitors only, and refuse most datacenter IPs. A US residential proxy is the default and what works; another country is switched to the US.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "resume": { "title": "Checkpoint progress", "type": "boolean", "description": "Save progress every ~30s so a run that gets migrated or restarted by the platform picks up where it stopped, without repeating products.", "default": true }, "continueFromLastRun": { "title": "Continue from last run", "type": "boolean", "description": "If your previous run with the same input was interrupted, scrape only what it missed. Products already collected stay in THAT run's dataset.", "default": false } } }, "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 } } } } } } } } } }