{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Seller Scraper", "description": "Scrape TikTok Shop sellers from store URLs, product URLs, or keyword searches. Get seller names, IDs, store links, ratings, followers, product counts, sample products, price ranges, and a transparent benchmark score. Clean CSV/JSON for ecommerce competitor research.", "version": "1.0", "x-build-id": "wTjqpkxWpdQKEMUsh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/coregent~tiktok-shop-seller-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-coregent-tiktok-shop-seller-scraper", "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/coregent~tiktok-shop-seller-scraper/runs": { "post": { "operationId": "runs-sync-coregent-tiktok-shop-seller-scraper", "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/coregent~tiktok-shop-seller-scraper/run-sync": { "post": { "operationId": "run-sync-coregent-tiktok-shop-seller-scraper", "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": { "keywords": { "title": "Keywords", "type": "array", "description": "Search TikTok Shop products by keyword and collect the sellers behind them (max 50 keywords). Several products from the same seller are combined into one seller row.", "default": [], "items": { "type": "string" } }, "sellerUrls": { "title": "Seller / store URLs or IDs", "type": "array", "description": "TikTok Shop store URLs (e.g. https://shop.tiktok.com/us/store//) or bare numeric seller IDs. The URL must contain the numeric seller ID; handle-only links (/@name) can't be resolved. The seller_id on any output row can be pasted back in here.", "default": [], "items": { "type": "string" } }, "productUrls": { "title": "Product URLs or IDs", "type": "array", "description": "TikTok Shop product URLs (e.g. https://shop.tiktok.com/view/product/ or //pdp//) or bare numeric product IDs. The seller behind each product is returned.", "default": [], "items": { "type": "string" } }, "region": { "title": "Region", "enum": [ "US", "MY", "TH", "VN", "PH", "SG" ], "type": "string", "description": "TikTok Shop marketplace to search and look up sellers in. Only markets where the data source returns results are listed.", "default": "US" }, "maxResults": { "title": "Max sellers", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Cap on saved unique seller rows across all inputs. Discovery and seller lookups stop as soon as this many sellers are saved.", "default": 10 }, "maxProductsPerKeyword": { "title": "Max products scanned per keyword", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many search results to scan per keyword when discovering sellers. One search page holds about 30 products. Raise it to find more sellers per keyword.", "default": 30 }, "includeSellerProfile": { "title": "Include seller profile", "type": "boolean", "description": "Look up each saved seller's store profile: rating, follower count, product count, official store link and category. Uses one extra lookup per unique seller. Turn off for the fastest name/ID/sample-products-only list.", "default": true }, "includeSampleProducts": { "title": "Include sample products", "type": "boolean", "description": "Add up to 5 sample product names and URLs plus a sample price range per seller, taken from products already fetched. No extra lookups.", "default": true }, "minSellerRating": { "title": "Minimum seller rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Drop sellers rated below this (0-5, e.g. 4.2). Sellers with no visible rating pass unless Strict filters is on. Needs 'Include seller profile' to see ratings.", "default": 0 }, "minSellerSoldCount": { "title": "Minimum seller sold count", "minimum": 0, "type": "integer", "description": "Drop sellers whose total sold count is below this. TikTok exposes a store-level sold count for only some sellers; those without one pass unless Strict filters is on.", "default": 0 }, "minProductCount": { "title": "Minimum product count", "minimum": 0, "type": "integer", "description": "Drop sellers with fewer listed products than this. Sellers with no visible product count pass unless Strict filters is on.", "default": 0 }, "strictFilters": { "title": "Strict filters", "type": "boolean", "description": "If on, a seller missing a filtered field fails that filter. If off (default), missing values pass, so useful sellers aren't lost when TikTok hides a metric.", "default": false }, "deduplicate": { "title": "Deduplicate sellers", "type": "boolean", "description": "Merge the same seller found by different inputs into one row (by seller ID, then URL, then name). If off, each input keeps its own row for a seller.", "default": true } } }, "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 } } } } } } } } } }