{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Product Scraper", "description": "Find TikTok Shop US products with TikTok Shop search, or compare product links. Export prices, sellers, stock, ratings and public review previews for product research. $1.49 per 1,000 products, with product details included and no start fee. Maintained by CleanScrape.", "version": "0.1", "x-build-id": "1CzgqGtwJpr7kaEka" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cleanscrape~tiktok-shop-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cleanscrape-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/cleanscrape~tiktok-shop-product-scraper/runs": { "post": { "operationId": "runs-sync-cleanscrape-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/cleanscrape~tiktok-shop-product-scraper/run-sync": { "post": { "operationId": "run-sync-cleanscrape-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": { "mode": { "title": "What would you like to do?", "enum": [ "search", "products" ], "type": "string", "description": "Find products by keyword searches TikTok Shop. Compare product links collects the products you paste. A link typed into the search field, or words typed into the link field, are still read the right way.", "default": "search" }, "searchQueries": { "title": "Search phrases", "type": "array", "description": "For Find products by keyword: one phrase per line, such as portable blender.", "items": { "type": "string" } }, "productUrls": { "title": "Product links", "type": "array", "description": "For Compare product links: product page links from TikTok Shop US, one per line. Short share links (vm.tiktok.com) don't work; open the product and copy the page address.", "items": { "type": "string" } }, "maxProducts": { "title": "Maximum products", "minimum": 1, "maximum": 500, "type": "integer", "description": "Total across all searches or links. Fewer may match.", "default": 20 }, "minPrice": { "title": "Minimum starting price (USD)", "minimum": 0, "maximum": 10000000, "type": "number", "description": "Compared with each product's lowest price. Some variants may cost more." }, "maxPrice": { "title": "Maximum starting price (USD)", "minimum": 0, "maximum": 10000000, "type": "number", "description": "Compared with each product's lowest price. See the Variants view for all prices." }, "minRating": { "title": "Minimum product rating", "minimum": 0, "maximum": 5, "type": "number", "description": "0 keeps all products. Above 0, products without a rating are left out.", "default": 0 }, "minSoldCount": { "title": "Minimum sold count", "minimum": 0, "type": "integer", "description": "As shown by TikTok Shop. This can be sales since the product was listed, not recent sales.", "default": 0 }, "includeWords": { "title": "Title must contain", "type": "array", "description": "Keep products whose title contains all of these words or phrases.", "items": { "type": "string" } }, "excludeWords": { "title": "Leave out titles containing", "type": "array", "description": "Leave out products whose title contains any of these.", "items": { "type": "string" } }, "includeReviewPreview": { "title": "Review preview", "type": "boolean", "description": "The few reviews shown on the product page. Not the full review history.", "default": true }, "market": { "title": "Marketplace", "enum": [ "US" ], "type": "string", "description": "Only the United States is supported.", "default": "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 }, "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 } } } } } } } } } }