{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Search Pro 🔥", "description": "TikTok Shop scraper for keyword and region search. Extract product IDs, titles, brands, sellers, prices, ratings, reviews, SKU pricing, and ranking data in clean structured output for ecommerce research, competitor tracking, trend discovery, and product sourcing.", "version": "1.1", "x-build-id": "1c9ISzXbmDCSrnxby" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sentry~tiktok-shop-search-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sentry-tiktok-shop-search-pro", "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/sentry~tiktok-shop-search-pro/runs": { "post": { "operationId": "runs-sync-sentry-tiktok-shop-search-pro", "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/sentry~tiktok-shop-search-pro/run-sync": { "post": { "operationId": "run-sync-sentry-tiktok-shop-search-pro", "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": { "queries": { "title": "Search Queries", "type": "array", "description": "Keywords to search on TikTok Shop (for example: \"ergo chair\", \"phone case\"). One dataset item is emitted per discovered product.", "default": [ "ergo chair" ], "items": { "type": "string" } }, "searchRegion": { "title": "Search Region", "type": "string", "description": "Region parameter sent to TikTok Shop search page (for example: US, GB).", "default": "US" }, "maxPagesPerQuery": { "title": "Max Pages Per Query", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of search-result pages to request per query. The crawler also stops early when no new results are found.", "default": 3 }, "maxResultsPerQuery": { "title": "Max Results Per Query", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Upper limit of unique products collected per query.", "default": 200 }, "includeRawProduct": { "title": "Include Raw Product Payload", "type": "boolean", "description": "Include the full raw product object in each dataset item. Disable this if you want smaller output payloads.", "default": true }, "compactNullFields": { "title": "Compact Null Fields", "type": "boolean", "description": "If true, omit fields that are null/undefined from output records to keep datasets cleaner.", "default": true }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of parallel HTTP requests.", "default": 5 }, "requestTimeoutSec": { "title": "Request Timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "HTTP request timeout for each page request.", "default": 30 }, "maxFetchRetries": { "title": "Max Fetch Retries", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many HTTP fetch attempts to try per page before giving up.", "default": 3 }, "queryRetryAttempts": { "title": "Full Query Retry Attempts", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many full retries to run for a query when blocked/failure signals produce zero results.", "default": 5 }, "failOnZeroAfterRetries": { "title": "Fail Run If Zero After Retries", "type": "boolean", "description": "If true, fail the run when all queries still return zero products after retry logic.", "default": false }, "forceMaxPages": { "title": "Force Max Pages (Testing)", "type": "boolean", "description": "If true, continue scanning until maxPagesPerQuery even when page appears exhausted (new=0 and hasMore=false). Useful for diagnostics.", "default": true }, "requireAllQueryTokens": { "title": "Require All Query Tokens", "type": "boolean", "description": "If true, each kept product must match all meaningful query tokens (after normalization).", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Choose proxy type and settings (Apify Proxy residential/datacenter or custom proxies).", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "minimumQueryTokenMatches": { "title": "Minimum Query Token Matches", "minimum": 1, "maximum": 5, "type": "integer", "description": "Minimum number of query tokens that must appear in product title/slug fields (used when Require All Query Tokens = false).", "default": 2 } } }, "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 } } } } } } } } } }