{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Similar Products", "description": "Find similar, competing, substitute, cheaper, premium, and related TikTok Shop products from a product URL, product title, or keyword seed.", "version": "1.0", "x-build-id": "dY961iTTwBeVhAzuo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sentry~tiktok-shop-similar-products/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sentry-tiktok-shop-similar-products", "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-similar-products/runs": { "post": { "operationId": "runs-sync-sentry-tiktok-shop-similar-products", "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-similar-products/run-sync": { "post": { "operationId": "run-sync-sentry-tiktok-shop-similar-products", "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": { "seeds": { "title": "Seed Products or Keywords", "type": "array", "description": "TikTok Shop product URLs, product titles, or keyword seeds. The actor finds similar products, substitutes, competing listings, and related alternatives.", "default": [ "neck fan", "ergo chair" ], "items": { "type": "string" } }, "searchRegion": { "title": "Search Region", "type": "string", "description": "Region parameter sent to TikTok Shop search, for example US or GB.", "default": "US" }, "maxQueriesPerSeed": { "title": "Max Search Queries Per Seed", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many related TikTok Shop searches to run for each seed product or keyword.", "default": 4 }, "maxPagesPerQuery": { "title": "Max Pages Per Search Query", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of TikTok Shop search-result pages to scan per generated search query.", "default": 3 }, "maxResultsPerSeed": { "title": "Max Similar Products Per Seed", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum similar-product records emitted per seed after filtering and sorting.", "default": 200 }, "minSimilarityScore": { "title": "Minimum Similarity Score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only emit products at or above this 0-100 similarity score. Use 0 to keep all scored matches.", "default": 0 }, "minRating": { "title": "Minimum Rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Optional minimum product rating. Products without a public rating are still allowed unless Require Reviews is enabled." }, "minReviewCount": { "title": "Minimum Review Count", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Only emit products with at least this many public reviews.", "default": 0 }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "type": "number", "description": "Optional maximum candidate product price." }, "requireReviews": { "title": "Require Reviews", "type": "boolean", "description": "If enabled, products with zero public reviews are excluded.", "default": false }, "includeRawProduct": { "title": "Include Raw Product Payload", "type": "boolean", "description": "Include the raw TikTok Shop product object in each dataset item. Disable this for smaller output payloads.", "default": false }, "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 }, "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 generated search 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 seed searches still return zero products after retry logic.", "default": false }, "forceMaxPages": { "title": "Force Max Pages", "type": "boolean", "description": "If true, continue scanning until Max Pages Per Search Query even when a page appears exhausted.", "default": true }, "requireAllQueryTokens": { "title": "Require All Query Tokens", "type": "boolean", "description": "If true, each kept product must match all meaningful tokens in the generated search query.", "default": false }, "minimumQueryTokenMatches": { "title": "Minimum Query Token Matches", "minimum": 1, "maximum": 5, "type": "integer", "description": "Minimum number of generated query tokens that must appear in product title/slug fields when Require All Query Tokens is false.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Choose proxy type and settings. Residential proxies are recommended for TikTok Shop.", "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 } } } } } } } } } }