{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Scraper - Products, Sales, Sellers & Reviews", "description": "Scrape TikTok Shop products, prices, units sold, SKUs, stock levels, reviews and full seller profiles - no login required. Includes rating histograms, spec tables, category paths, seller business details and related-product discovery. Export CSV/JSON. Pay per result, no start fee.", "version": "0.1", "x-build-id": "9tNtf9yidO5svD3Q9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapesage~tiktok-shop-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapesage-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/scrapesage~tiktok-shop-scraper/runs": { "post": { "operationId": "runs-sync-scrapesage-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/scrapesage~tiktok-shop-scraper/run-sync": { "post": { "operationId": "run-sync-scrapesage-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": { "mode": { "title": "What to scrape", "enum": [ "product", "shop", "reviews", "sellers", "discover" ], "type": "string", "description": "product = one rich row per product (reviews, affiliate videos and seller details nested in). shop = a seller's catalog. reviews = one row per review. sellers = seller lead records. discover = expand through TikTok's related / best-selling / you-may-like rails to find new products.", "default": "product" }, "productUrls": { "title": "Product URLs or IDs", "type": "array", "description": "TikTok Shop product links, e.g. https://shop.tiktok.com/us/pdp// — a bare product ID also works. Used by product, reviews, sellers and discover modes.", "items": { "type": "string" } }, "shopUrls": { "title": "Shop URLs or seller IDs", "type": "array", "description": "TikTok Shop store links, e.g. https://shop.tiktok.com/us/store// — a bare seller ID also works. Used by shop, sellers and discover modes.", "items": { "type": "string" } }, "region": { "title": "TikTok Shop region", "enum": [ "US", "GB", "ID", "MY", "TH", "VN", "PH", "SG", "DE", "FR", "IT", "ES", "IE", "JP", "MX", "BR" ], "type": "string", "description": "Marketplace to read prices and availability from.", "default": "US" }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Stop after this many records. Set 0 for no cap — the run still self-terminates safely before its timeout.", "default": 50 }, "fullDetail": { "title": "Full detail for every product", "type": "boolean", "description": "In shop and discover modes, open each product's own page so every row is a complete product record (specs, SKUs with stock, reviews, affiliate videos) instead of a catalog listing. Much richer, but one request per product so runs take longer.", "default": false }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Nest the customer reviews shown on each product page (rating, text, photos, verified-purchase flag) inside the product record. Use 'reviews' mode instead if you want one row per review.", "default": true }, "includeAffiliateVideos": { "title": "Include affiliate videos", "type": "boolean", "description": "Nest the TikTok videos promoting each product — creator name, play and like counts, and whether the creator earns commission. Useful for affiliate and influencer research.", "default": true }, "resolveExactPrice": { "title": "Resolve exact price", "type": "boolean", "description": "TikTok hides the headline price on a product page from automated clients. When enabled, the exact current and original price are recovered from the seller's own catalog listing. Leave on unless you want the fastest possible run.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. This Actor reads TikTok Shop's server-rendered pages directly and normally needs no proxy at all; a proxy is only used as a fallback if the datacenter IP gets rate-limited.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } }, "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 } } } } } } } } } }