{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Shoppable Video & Creative Finder", "description": "Find public TikTok videos connected to Shop products. Compare views, engagement, caption hooks, CTAs, formats, creative angles, creators, and transparent product-association confidence.", "version": "0.1", "x-build-id": "8eqKEUnBx9XHsLkR2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexascout~tiktok-shop-shoppable-video-creative-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexascout-tiktok-shop-shoppable-video-creative-finder", "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/nexascout~tiktok-shop-shoppable-video-creative-finder/runs": { "post": { "operationId": "runs-sync-nexascout-tiktok-shop-shoppable-video-creative-finder", "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/nexascout~tiktok-shop-shoppable-video-creative-finder/run-sync": { "post": { "operationId": "run-sync-nexascout-tiktok-shop-shoppable-video-creative-finder", "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": { "productUrls": { "title": "TikTok Shop product URLs", "maxItems": 20, "type": "array", "description": "Find public TikTok videos for specific TikTok Shop products.", "items": { "type": "object", "properties": { "url": { "type": "string", "title": "URL", "description": "A public TikTok Shop product-detail URL." } }, "required": [ "url" ] }, "default": [ { "url": "https://shop.tiktok.com/us/pdp/hpbs-24000mah-power-bank-6000a-jump-starter-150psi-inflate/1731973421800919262" } ] }, "searchQueries": { "title": "Product niches or keywords", "maxItems": 5, "type": "array", "description": "Discover TikTok Shop products by niche before finding their public videos.", "default": [], "items": { "type": "string" } }, "region": { "title": "TikTok Shop region", "enum": [ "US" ], "type": "string", "description": "TikTok Shop market code. This release supports the United States.", "default": "US" }, "maxProductsPerQuery": { "title": "Maximum products per keyword", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum verified products analyzed for each keyword.", "default": 1 }, "maxCreativesPerProduct": { "title": "Maximum creatives per product", "minimum": 1, "maximum": 30, "type": "integer", "description": "Maximum public video/product associations returned for each analyzed product.", "default": 10 }, "maxBrowserRequests": { "title": "Maximum browser pages per run", "minimum": 5, "maximum": 100, "type": "integer", "description": "Hard cap across product, search, video-search, and video-detail pages.", "default": 30 }, "minVideoViews": { "title": "Minimum public video views", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Exclude videos below this public view count. Keep 0 when view count may be unavailable.", "default": 0 }, "searchPublicTikTokVideos": { "title": "Search public TikTok videos when PDP has none", "type": "boolean", "description": "Search public TikTok/indexed video pages when the product page exposes no videos. These rows are labeled as search-context leads.", "default": true }, "sortBy": { "title": "Sort creatives by", "enum": [ "CREATIVE_SCORE", "VIDEO_VIEWS", "ENGAGEMENT_RATE", "RECENT", "PRODUCT_SALES" ], "type": "string", "description": "Controls the final dataset order.", "default": "CREATIVE_SCORE" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "US residential proxy is recommended because TikTok Shop is geo-sensitive.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "maxConcurrency": { "title": "Maximum extraction concurrency", "minimum": 1, "maximum": 2, "type": "integer", "description": "Keep at 1–2 to reduce TikTok security challenges and proxy traffic.", "default": 2 }, "navigationTimeoutSecs": { "title": "Navigation timeout (seconds)", "minimum": 15, "maximum": 120, "type": "integer", "description": "Maximum time allowed for each HTTP or browser navigation.", "default": 45 }, "includeRawData": { "title": "Include raw source data", "type": "boolean", "description": "Include the captured raw video object when available. Useful for debugging but increases export size.", "default": false }, "includeSearchFallbacks": { "title": "Include unverified search-only products", "type": "boolean", "description": "Allow indexed product leads when live TikTok Shop validation fails. Disabled by default.", "default": false } } }, "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 } } } } } } } } } }