{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Scraper (No Login) - Sales & Stock in 10 Countries", "description": "Scrape TikTok Shop products without an account in the US, UK, Singapore, Malaysia, Thailand, Philippines, Vietnam, Indonesia, Mexico and Japan: price, units sold, stock per variant, ratings, reviews, shipping and shop stats. By product URL, keyword or category, with a scheduled 'what changed' mode.", "version": "0.1", "x-build-id": "UeTfPVd9HzRdwZaCE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/headply~tiktok-shop-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-headply-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/headply~tiktok-shop-scraper/runs": { "post": { "operationId": "runs-sync-headply-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/headply~tiktok-shop-scraper/run-sync": { "post": { "operationId": "run-sync-headply-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": { "region": { "title": "Country (storefront)", "enum": [ "us", "gb", "sg", "my", "th", "ph", "vn", "id", "mx", "jp" ], "type": "string", "description": "Which TikTok Shop country to use for keywords, categories and bare product IDs. Product URLs always use the country in the URL.", "default": "us" }, "products": { "title": "Product URLs or IDs", "type": "array", "description": "TikTok Shop product links from any of the 10 countries (for example https://shop.tiktok.com/us/pdp/1729488565791527807) or bare product IDs.", "items": { "type": "string" } }, "keywords": { "title": "Keywords (US)", "type": "array", "description": "Phrases such as 'phone cases' or 'stanley cup'. Returns TikTok Shop's product list for that phrase (up to 30 products). US storefront only; phrases TikTok Shop has no list for are reported in the run summary and not billed.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Category names (for example 'Beauty & Personal Care') or category links from any of the 10 countries. Each category returns a sample of its current products.", "items": { "type": "string" } }, "includeSubcategories": { "title": "Include subcategories", "type": "boolean", "description": "Also sample the category's subcategories, for wider coverage.", "default": false }, "maxProductsPerSource": { "title": "Max products per keyword or category", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Upper limit for each keyword and each category.", "default": 30 }, "includeDetails": { "title": "Full product details", "type": "boolean", "description": "On: every product with variants and stock, shipping, description, reviews and shop stats. Off: only the list data (title, price, units sold, rating) - cheaper and faster. Product URLs always return full details.", "default": true }, "monitorChanges": { "title": "Only new or changed products (for schedules)", "type": "boolean", "description": "Remembers every product between runs and returns only products that are new or whose units sold, stock, rating, reviews or price changed, with the change in a 'changes' field. Unchanged products are not billed.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Keep separate memories for different schedules (for example 'competitors').", "default": "default" } } }, "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 } } } } } } } } } }