{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Affiliate Creator & Video Finder", "description": "Find public TikTok Shop creator videos, profiles, engagement metrics, and transparent affiliate-momentum signals by product URL or keyword.", "version": "0.1", "x-build-id": "pOvxfeqyUeVLZyklo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexascout~tiktok-shop-affiliate-creator-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexascout-tiktok-shop-affiliate-creator-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-affiliate-creator-finder/runs": { "post": { "operationId": "runs-sync-nexascout-tiktok-shop-affiliate-creator-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-affiliate-creator-finder/run-sync": { "post": { "operationId": "run-sync-nexascout-tiktok-shop-affiliate-creator-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": 30, "type": "array", "description": "Optional public TikTok Shop product-detail pages whose creator/video evidence should be analyzed. Combine with searchQueries or leave empty for niche discovery.", "items": { "type": "object", "properties": { "url": { "type": "string", "title": "URL", "description": "A public TikTok Shop product URL." } }, "required": [ "url" ] }, "default": [] }, "searchQueries": { "title": "Product niches or keywords", "maxItems": 10, "type": "array", "description": "Optional product niches or keywords used to discover products before creator/video analysis. Use at least one query or product URL; the default query keeps Store and MCP test runs non-empty.", "default": [ "car accessories" ], "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 analyzed products per keyword", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum billable analyzed-product rows returned per keyword. Each row contains nested creators and videos; smaller runs are faster and cheaper.", "default": 1 }, "maxVideosPerProduct": { "title": "Maximum creator videos per product", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum public creator/video records retained inside each analyzed product row.", "default": 20 }, "maxCreatorsPerProduct": { "title": "Maximum creators per product", "minimum": 1, "maximum": 25, "type": "integer", "description": "Maximum ranked creator profiles retained inside each analyzed product row.", "default": 10 }, "minVideoViews": { "title": "Minimum public video views", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Exclude videos below this public view count. Keep 0 to include videos whose view count is missing.", "default": 0 }, "searchPublicTikTokVideos": { "title": "Search public TikTok videos when PDP has none", "type": "boolean", "description": "When the product page exposes no creator videos, search TikTok's public video results and retain only title/brand-relevant leads. These results are clearly labeled as search-query context, not proven affiliate attribution.", "default": true }, "sortBy": { "title": "Sort analyzed products by", "enum": [ "AFFILIATE_MOMENTUM", "VIDEO_VIEWS", "CREATOR_FOLLOWERS", "AFFILIATE_VIDEO_COUNT", "PRODUCT_VIRAL_SCORE" ], "type": "string", "description": "Controls analyzed-product ordering. AFFILIATE_MOMENTUM is recommended when the goal is to identify promising public creator/video evidence.", "default": "AFFILIATE_MOMENTUM" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "US residential proxy is recommended because TikTok Shop is geo-sensitive and rate-limits data-center traffic.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "maxConcurrency": { "title": "Maximum extraction concurrency", "minimum": 1, "maximum": 2, "type": "integer", "description": "Keep this at 1–2 to reduce TikTok security challenges and residential 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 best raw product and video objects captured from TikTok. Useful for debugging, but makes exports larger.", "default": false }, "includeSearchFallbacks": { "title": "Include unverified search-only products", "type": "boolean", "description": "Return indexed product URLs even when their live PDP cannot be validated. Disabled by default; enabled rows are also billable analyzed products.", "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 } } } } } } } } } }