{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Affiliate Finder — Who Promotes a Product or Shop", "description": "🎯 Find the TikTok creators who promoted a TikTok Shop product, any product from a shop, or products like yours. Get their 💰 GMV, the products they sell and their contact emails ✨", "version": "1.0", "x-build-id": "AvV2PZdA3kw1FKX10" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataovercoffee~tiktok-shop-affiliate-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataovercoffee-tiktok-shop-affiliate-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/dataovercoffee~tiktok-shop-affiliate-finder/runs": { "post": { "operationId": "runs-sync-dataovercoffee-tiktok-shop-affiliate-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/dataovercoffee~tiktok-shop-affiliate-finder/run-sync": { "post": { "operationId": "run-sync-dataovercoffee-tiktok-shop-affiliate-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": { "find_by": { "title": "Find creators who promoted", "enum": [ "product", "shop", "description" ], "type": "string", "description": "Pick one way to search, then fill in the matching box below.", "default": "shop" }, "product": { "title": "Product link", "type": "string", "description": "Used when you pick \"This product\". Paste the link to one TikTok Shop product, like https://shop.tiktok.com/us/pdp/1729619454557917428. You get the creators who promoted this product." }, "shop": { "title": "Shop link", "type": "string", "description": "Used when you pick \"Any product from this shop\". Paste the link to one shop on TikTok Shop. You get the creators who promoted any product from this shop.", "default": "https://shop.tiktok.com/us/store/nooni/7495586169586223348" }, "description": { "title": "Product description", "type": "string", "description": "Used when you pick \"Products like my description\". Describe a product in a few words, like \"lightweight facial sunscreen\". You get the creators who promoted products like it." }, "limit": { "title": "Maximum results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "The most creators you want back. You pay for each creator you get.", "default": 10 }, "markets": { "title": "Sales markets", "type": "array", "description": "Where the creators sell: the United States, the United Kingdom, or both.", "items": { "type": "string", "enum": [ "US", "GB" ], "enumTitles": [ "United States", "United Kingdom" ] }, "default": [ "US", "GB" ] }, "gmv_period": { "title": "GMV period", "enum": [ "7" ], "type": "string", "description": "How many days of GMV the GMV and GPM filters and sorting use.", "default": "7" }, "min_gmv_usd": { "title": "Minimum GMV (USD)", "minimum": 0, "type": "integer", "description": "Only show creators with at least this much GMV in the GMV period." }, "max_gmv_usd": { "title": "Maximum GMV (USD)", "minimum": 0, "type": "integer", "description": "Only show creators with at most this much GMV in the GMV period." }, "min_gpm_usd": { "title": "Minimum GPM (USD)", "minimum": 0, "type": "integer", "description": "Only show creators with at least this much GMV per 1,000 views in the GMV period." }, "max_gpm_usd": { "title": "Maximum GPM (USD)", "minimum": 0, "type": "integer", "description": "Only show creators with at most this much GMV per 1,000 views in the GMV period." }, "min_growth_pct": { "title": "Minimum GMV growth (%)", "type": "integer", "description": "Only show creators whose GMV grew at least this much compared with the period before. For example, 50 means GMV went up by half or more." }, "active_within_days": { "title": "Promoted in the last (days)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Only show creators who promoted one of the products you searched for within this many days. For example, 30 means the last month." }, "min_shops_promoted": { "title": "Minimum shops promoted", "minimum": 0, "type": "integer", "description": "Only show creators who promoted products from at least this many different shops." }, "max_shops_promoted": { "title": "Maximum shops promoted", "minimum": 0, "type": "integer", "description": "Only show creators who promoted products from at most this many different shops." }, "sort_by": { "title": "Sort by", "enum": [ "gmv", "growth", "followers" ], "type": "string", "description": "Who comes first in your list.", "default": "gmv" }, "min_followers": { "title": "Minimum followers", "minimum": 1000, "type": "integer", "description": "Only show creators with at least this many followers." }, "max_followers": { "title": "Maximum followers", "minimum": 1000, "type": "integer", "description": "Only show creators with at most this many followers." }, "min_avg_play_count": { "title": "Minimum average views", "minimum": 0, "type": "integer", "description": "Only show creators whose recent videos get at least this many views on average." }, "max_avg_play_count": { "title": "Maximum average views", "minimum": 0, "type": "integer", "description": "Only show creators whose recent videos get at most this many views on average." }, "min_avg_like_count": { "title": "Minimum average likes", "minimum": 0, "type": "integer", "description": "Only show creators whose recent videos get at least this many likes on average." }, "max_avg_like_count": { "title": "Maximum average likes", "minimum": 0, "type": "integer", "description": "Only show creators whose recent videos get at most this many likes on average." }, "min_avg_comment_count": { "title": "Minimum average comments", "minimum": 0, "type": "integer", "description": "Only show creators whose recent videos get at least this many comments on average." }, "max_avg_comment_count": { "title": "Maximum average comments", "minimum": 0, "type": "integer", "description": "Only show creators whose recent videos get at most this many comments on average." }, "only_with_email": { "title": "Only creators with an email", "type": "boolean", "description": "Only show creators who have an email address you can contact.", "default": false }, "exclude_usernames": { "title": "Exclude creators", "type": "array", "description": "Creators you already know. Paste TikTok usernames or profile links, one per line. They are left out of your list.", "items": { "type": "string" } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }