{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Scraper — Price, Sales, Rating by URL · $0.006/item", "description": "TikTok Shop product data from product URLs: title, price, units sold, rating, reviews and shop at $0.006/item, plus a $0.01 run fee on success. Keyword search ($0.004/card) is temporarily unavailable and costs $0. Fresh US proxy session per product; failures are never charged.", "version": "0.2", "x-build-id": "BRhzgKpr77usc7ibB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawleast~tiktok-shop-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawleast-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/crawleast~tiktok-shop-product-scraper/runs": { "post": { "operationId": "runs-sync-crawleast-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/crawleast~tiktok-shop-product-scraper/run-sync": { "post": { "operationId": "run-sync-crawleast-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": { "productUrls": { "title": "Product URLs", "maxItems": 100, "type": "array", "description": "TikTok Shop product page URLs to fetch (up to 100 per run, duplicates auto-removed). Accepts any product-link shape: https://www.tiktok.com/view/product/, https://shop.tiktok.com/view/product/, regional pdp links (https://shop.tiktok.com/us/pdp//) and partner links with tracking parameters — the numeric product ID is extracted automatically. You may also pass a single URL string, or use the single-value aliases \"productUrl\" / \"url\"; the Actor normalizes any of these to a one-item list. For best results, use 1-2 URLs per run; batch mode is beta — success rate decreases with batch size (batches pace 12-15s per URL with a 30s cooldown after any CAPTCHA wall). In batch runs a REGION_UNAVAILABLE verdict can also reflect a batch-level soft block — retrying that URL in its own single-URL run usually delivers it. Leaving this empty ends the run honestly as NO_INPUT at $0.", "items": { "type": "string" } }, "region": { "title": "TikTok Shop region", "enum": [ "US", "UK", "ID", "TH", "VN", "MY", "PH" ], "type": "string", "description": "Marketplace label attached to every delivered row (informational; the scraper fetches the product page as served). US is the primary market.", "default": "US" }, "enrichShop": { "title": "Enrich with shop info", "type": "boolean", "description": "Best-effort shop identity extraction (name and ID) from on-page signals. Note: shop.tiktok.com storefront pages are captcha-walled, so shop fields come only from the product page itself — no extra requests are made.", "default": false }, "maxTotalChargeUsd": { "title": "Budget cap (USD)", "minimum": 0.01, "type": "number", "description": "Hard per-run billing ceiling. Charging stops at this amount; items beyond the cap are still delivered but marked uncharged in the SUMMARY ledger — nothing is dropped silently. Default $2 covers ~330 products at the $0.006 per-item rate.", "default": 2 }, "searchKeywords": { "title": "Search keywords", "type": "array", "description": "Temporarily unavailable: the product-discovery source behind keyword search blocks automated queries, so keywords are not searched — each one ends as SEARCH_UNAVAILABLE and costs $0. Use Product URLs above until search returns. When available: keywords to search on TikTok (e.g. 'pet grooming brush', 'tiktok made me buy it'); the Actor scans top videos for these keywords and extracts every TikTok Shop product card it finds (one row per product, $0.004/card). Entries over 64 characters are rejected individually (INVALID_KEYWORD, $0) while the rest run. Combine with productUrls in the same run — both are processed independently and billed separately. Leaving both empty ends the run honestly as NO_INPUT at $0.", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "maxResultsPerKeyword": { "title": "Max results per keyword", "minimum": 1, "maximum": 100, "type": "integer", "description": "Ceiling on search cards delivered per keyword (1-100, default 30). Results beyond the cap are truncated and recorded in the SUMMARY (truncatedItems) — truncation is never charged.", "default": 30 }, "sort": { "title": "Sort", "enum": [ "default", "sales", "priceAsc", "priceDesc" ], "type": "string", "description": "Result ordering for keyword search. 'default' keeps the search engine's relevance order (similarityRank = relevance position).", "default": "default" }, "includeDetails": { "title": "Enrich search cards with full details", "type": "boolean", "description": "When true, every search card is additionally fetched through the full product-page pipeline (title, price, sold count, rating, reviews, shop) and billed as detail-item ($0.006) on top of the search-item ($0.004). When false (default) you get the lightweight card only.", "default": false }, "filterByRegion": { "title": "Filter by region", "type": "boolean", "description": "Bias the keyword's TikTok search stream to the selected region marketplace (default true; product discovery itself is region-agnostic). Turn off for the default US stream.", "default": 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 } } } } } } } } } }