{ "openapi": "3.0.1", "info": { "title": "TikTok Shop 小店 Product Scraper - Prices, Units Sold & Sellers", "description": "Scrapes TikTok Shop product listings by category section with optional detail enrichment. Returns each product as a flat row with price, rating, units sold, and seller store stats.", "version": "1.0", "x-build-id": "ykaIgPbaTaKoDhQzm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~tiktok-shop-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-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/parseforge~tiktok-shop-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-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/parseforge~tiktok-shop-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-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": { "maxItems": { "title": "Maximum products", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of products to collect per run." }, "category": { "title": "Product Section", "enum": [ "", "Top Selling", "Trending", "Discounted", "Featured", "Flash Sale", "Premium Offers" ], "type": "string", "description": "Filter by shop section. Leave empty for all sections." }, "minPrice": { "title": "Min Price ($)", "minimum": 0, "type": "number", "description": "Minimum sale price in USD." }, "maxPrice": { "title": "Max Price ($)", "minimum": 0, "type": "number", "description": "Maximum sale price in USD." }, "minRating": { "title": "Min Rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Minimum product rating (0-5)." }, "minSold": { "title": "Min Units Sold", "minimum": 0, "type": "integer", "description": "Minimum number of units sold." }, "includeDetails": { "title": "Include Product Details", "type": "boolean", "description": "Fetch each product's detail page for category hierarchy, total reviews, and seller store stats (followers, product count, total sold). Slower but more data. Note: approximately 75% of products will be enriched - some products are restricted by TikTok.", "default": false }, "includeVariants": { "title": "πŸ“¦ Include variants, prices and stock", "type": "boolean", "description": "Adds every variant (SKU) of the product with its options (color, size), sale and original price, units in stock, GTIN barcode and package size, plus variantCount, totalStock and priceRange. One extra request per product, shared with the other detail options. Charged only for a row that receives it.", "default": false }, "includeProductContent": { "title": "πŸ“ Include description, images, specs and shipping", "type": "boolean", "description": "Adds the full product description, the TikTok AI summary, every gallery and description image, the specification table and the shipping fee with delivery days. One extra request per product, shared with the other detail options. Charged only for a row that receives it.", "default": false }, "includeReviews": { "title": "⭐ Include rating breakdown and top reviews", "type": "boolean", "description": "Adds the review score, the 1 to 5 star breakdown and the reviews TikTok shows on the product page (text, rating, date, variant bought, photos). One extra request per product, shared with the other detail options. Charged only for a row that receives it.", "default": false }, "includeSellerInfo": { "title": "🏒 Include seller business name and address", "type": "boolean", "description": "Adds the registered business name and business address the seller discloses on the product page, plus the shop rating, shop URL and video count. One extra request per product, shared with the other detail options. Charged only for a row that receives it.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "US residential proxy required for TikTok Shop access." } } }, "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 } } } } } } } } } }