{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Scraper - Products, Prices, Sales & Reviews", "description": "Scrape TikTok Shop products by keyword, shop or URL: price, discount, units sold, rating, SKUs and stock, promoting creator videos and customer reviews.", "version": "1.0", "x-build-id": "hiww9rutmVG7euwpV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/seemuapps~tiktok-shop-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-seemuapps-tiktok-shop-products-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/seemuapps~tiktok-shop-products-scraper/runs": { "post": { "operationId": "runs-sync-seemuapps-tiktok-shop-products-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/seemuapps~tiktok-shop-products-scraper/run-sync": { "post": { "operationId": "run-sync-seemuapps-tiktok-shop-products-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", "required": [ "mode" ], "properties": { "mode": { "title": "What to scrape", "enum": [ "search", "shop", "details", "reviews" ], "type": "string", "description": "Keyword search and Shop catalog return product listings. Product details returns the full product page for each URL, including variants/SKUs with stock, shipping, shop stats and the creator videos promoting the product. Product reviews returns one row per customer review.", "default": "search" }, "keywords": { "title": "Search keywords", "type": "array", "description": "Used in Keyword search mode. One search term per line, e.g. 'phone case', 'lip gloss', 'dog toy'. Each keyword returns up to about 200 unique products.", "items": { "type": "string" } }, "shopUrls": { "title": "Shop URLs", "type": "array", "description": "Used in Shop catalog mode. TikTok Shop store URLs such as https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079, or just the numeric shop id. Shop ids also appear in the shopId column of search results.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Used in Product details and Product reviews modes. TikTok Shop product URLs such as https://www.tiktok.com/shop/pdp/goli-ashwagandha-gummies/1729587769570529799, or just the numeric product id.", "items": { "type": "string" } }, "region": { "title": "Shop region", "enum": [ "US", "GB", "DE", "FR", "IT", "ES", "IE", "MX", "BR", "JP", "ID", "MY", "PH", "SG", "TH", "VN" ], "type": "string", "description": "TikTok Shop marketplace to scrape. The US has full coverage in every mode. Other regions work for keyword search; shop catalogs, product details and reviews outside the US are often incomplete or empty.", "default": "US" }, "shopSort": { "title": "Shop catalog order", "enum": [ "top", "new_releases" ], "type": "string", "description": "Used in Shop catalog mode. Best-selling first surfaces a store's winners; Newest first shows what the seller just launched.", "default": "top" }, "maxItems": { "title": "Max results per keyword / shop / product", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum rows for each keyword, shop or product (reviews mode: reviews per product), up to 1000 per run. To go further, resume with Page ID. Ignored in Product details mode, which returns one row per URL.", "default": 100 }, "fetchDetails": { "title": "Include full product details", "type": "boolean", "description": "Keyword search and Shop catalog modes only. Also opens each product page to add all images, description, specifications, every SKU with price and stock, shipping, shop stats and promoting creator videos. Slower, and each enriched row is billed as a product-details result.", "default": false }, "pageId": { "title": "Page ID (pagination)", "type": "string", "description": "Paste NEXT_PAGE_ID from the previous run's Key-value store to continue where it stopped. Keep the same mode and input list. Leave empty to start from the beginning." } } }, "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 } } } } } } } } } }