{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Scraper - Search, Prices & Reviews", "description": "Search TikTok Shop by keyword or browse its categories. Returns title, price, discount, brand, shop, rating with review count, units sold and promotion badges, plus the description and seller stats on product pages.", "version": "0.1", "x-build-id": "IUzAmongtfuSkdEXj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~tiktok-shop/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-tiktok-shop", "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/s-r~tiktok-shop/runs": { "post": { "operationId": "runs-sync-s-r-tiktok-shop", "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/s-r~tiktok-shop/run-sync": { "post": { "operationId": "run-sync-s-r-tiktok-shop", "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": { "keyword": { "title": "Keyword filter", "type": "string", "description": "Search TikTok Shop for this. TikTok publishes no search endpoint, so the matching product pages are found in a public web index and then read live from TikTok: only the finding is second-hand, every price and rating comes from TikTok at run time. Give categories as well and the keyword filters those instead." }, "targets": { "title": "Categories or products", "type": "array", "description": "TikTok Shop category URLs or ids (700645), product URLs or ids. A bare six-digit number is read as a category and a long one as a product, and the slug in a URL is ignored because the id is what resolves. Leave empty to read six of the storefront's largest categories.", "items": { "type": "string" } }, "max_products": { "title": "Maximum products", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Stop after this many distinct products. Also the cost ceiling for the run, and the thing to raise before passes when you want more.", "default": 100 }, "search_pages": { "title": "Search result pages", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many pages of search results to resolve, roughly ten products each. Only used when a keyword is given with no categories." }, "passes": { "title": "Passes per category", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many times to re-request each category. The product list is rotated per request rather than paginated, so asking again is what pages it: four passes of one category returned 55 distinct products where one returned 15. Defaults to 3, or 6 when a keyword is set. Leave empty to let the Actor choose." }, "subcategory_depth": { "title": "Subcategory depth", "minimum": 0, "maximum": 3, "type": "integer", "description": "How many levels of subcategories to walk. Each category page lists its own children, so 1 turns a single category into its whole first level. Defaults to 0, or 1 when a keyword is set. Leave empty to let the Actor choose." }, "attempts": { "title": "Attempts per page", "minimum": 1, "maximum": 25, "type": "integer", "description": "The storefront answers with an empty shell roughly three times in four and the same request succeeds on a later try, so pages are retried. Ten attempts clear about 90 percent. Raise it if a run reports pages it could not read.", "default": 10 }, "region": { "title": "Market", "type": "string", "description": "Two-letter market code, which sets both the storefront and the exit country. The United States storefront is the one this has been verified against.", "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 } } }, "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 } } } } } } } } } }