{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Scraper: Products, Price, Stock, Sold Count", "description": "TikTok Shop products by product, store or category link: price, variant stock, sold count, rating, seller stats, $22.50 per 1,000. Card rows (price, sold count, rating) $7.50 per 1,000. pratikdani/tiktok-shop-scraper and unseenuser input works. US and UK, no login, free error rows.", "version": "0.1", "x-build-id": "0bnV5N16eGlCgsWtV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arcadium~tiktok-shop-products/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arcadium-tiktok-shop-products", "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/arcadium~tiktok-shop-products/runs": { "post": { "operationId": "runs-sync-arcadium-tiktok-shop-products", "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/arcadium~tiktok-shop-products/run-sync": { "post": { "operationId": "run-sync-arcadium-tiktok-shop-products", "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": { "startUrls": { "title": "TikTok Shop URLs or product ids", "type": "array", "description": "Product URLs or ids (https://www.tiktok.com/shop/pdp/1729541517648171786 or 1729541517648171786) give full product details. Store URLs (https://www.tiktok.com/shop/store/asterwood/7495384600901552906) read the store's products; category URLs (https://shop.tiktok.com/us/c/beauty-personal-care/601450) a sample of the category. Give at least one; no keyword search. Also accepted as url (pratikdani), productUrls / shopUrls (unseenuser), productIds, storeUrls or urls.", "items": { "type": "string" } }, "region": { "title": "Market for bare product ids", "enum": [ "US", "GB" ], "type": "string", "description": "Market used for product ids and URLs without a region: US (default) or GB. URLs with /us/ or /gb/ keep their own market. Other TikTok Shop markets are not served to anonymous visitors. Also accepted as `country_code` or `country`; UK means GB." }, "maxProductsPerUrl": { "title": "Max products per store or category URL", "minimum": 1, "maximum": 500, "type": "integer", "description": "Products read per store or category URL, e.g. 20 (the default). A store page lists its first ~20 products; a category page shows a changing sample, which is reloaded until it stops adding new products. Also accepted as `maxResults` (0 = 500, the maximum) or `maxProducts`." }, "maxItems": { "title": "Max products in total", "minimum": 1, "type": "integer", "description": "Optional cap on charged products for the whole run, e.g. 500. Empty means no cap beyond the per-URL limit. Also accepted as `limit`." }, "description": { "title": "Description", "enum": [ "short", "full", "none" ], "type": "string", "description": "short (first 300 characters, default), full, or none. Emails and phone numbers are always removed." }, "includeReviews": { "title": "Include the reviews shown on the page", "type": "boolean", "description": "Adds the up to 5 reviews the product page shows (rating, text, date, variant, verified and incentivized flags; never reviewer names). No extra charge.", "default": true }, "cardFallback": { "title": "Card rows for products TikTok does not open", "type": "boolean", "description": "TikTok serves some product pages to anonymous visitors only behind a check page. For products found on a store or category page, return what the card shows (title, price, discount, sold count, rating, seller, image) as a cheaper 'product-card' row instead of a free error row. On by default.", "default": true }, "includeErrorRows": { "title": "Add a row for inputs that failed", "type": "boolean", "description": "Adds a free row for every input that returned nothing or could not be read (removed product, wrong id, unsupported market), so a failure is never silent.", "default": true }, "maxRetries": { "title": "Retries per page", "minimum": 0, "maximum": 10, "type": "integer", "description": "How often a blocked or failed page is retried on a new connection, e.g. 3 (the default).", "default": 3 }, "proxyConfiguration": { "title": "Proxy (advanced)", "type": "object", "description": "Leave empty. The actor uses datacenter IPs for US pages (residential as a fallback) and residential GB IPs for GB pages." } } }, "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 } } } } } } } } } }