{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Stores — Search, Rankings & Products", "description": "Research TikTok Shop stores by market, category, sales and ratings. Get shop details, products, promoting creators, videos, rankings and market analytics. Export structured results as JSON, CSV or Excel.", "version": "0.0", "x-build-id": "TVXhZauagZ83kgcv6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datanebula~tiktok-shop-stores/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datanebula-tiktok-shop-stores", "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/datanebula~tiktok-shop-stores/runs": { "post": { "operationId": "runs-sync-datanebula-tiktok-shop-stores", "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/datanebula~tiktok-shop-stores/run-sync": { "post": { "operationId": "run-sync-datanebula-tiktok-shop-stores", "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", "required": [ "operation", "country" ], "properties": { "operation": { "title": "Operation", "enum": [ "sellers-search", "dashboards-sellers-concentration", "dashboards-sellers-metrics", "sellers-ranking-most-promoted", "sellers-ranking-top-selling", "sellers-detail", "sellers-creators", "sellers-products", "sellers-videos" ], "type": "string", "description": "Choose one operation per run. See the README for the required inputs for each operation.", "default": "sellers-search" }, "country": { "title": "Market", "enum": [ "br", "de", "es", "fr", "gb", "id", "it", "jp", "mx", "my", "ph", "sg", "th", "us", "vn" ], "type": "string", "description": "Use the market in which the entity ID was found. Data coverage varies by market.", "default": "us" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Total result rows across this run. Stops pagination at this limit. Apify Free plan users receive up to 20 rows per run. Analytical results may contain nested report data.", "default": 10 }, "ids": { "title": "Entity IDs", "maxItems": 100, "type": "array", "description": "Required for details and related data. Paste IDs returned by a search in the selected market. Handles and URLs are not supported.", "items": { "type": "string" } }, "include": { "title": "Additional detail sections", "type": "array", "description": "Optional sections for detail operations only. These do not fetch related lists such as comments or videos.", "items": { "type": "string", "enum": [ "channel", "core" ] } }, "keyword": { "title": "Keyword", "type": "string", "description": "Search keyword\nApplies to: Search Shops." }, "category": { "title": "Category", "type": "string", "description": "Shop main category ID\nApplies to: Search Shops; Shop Market Concentration; Shop Market Overview; Most-Promoted Shops; Top-Selling Shops.\nEnter a category ID or a category name from the reference table, such as Beauty & Personal Care." }, "seller_type": { "title": "Seller type", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Seller type: 1 = overseas non-brand; 2 = local; 3 = brand; 4 = non-brand.\nApplies to: Search Shops." }, "min_rating": { "title": "Min rating", "type": "number", "description": "Minimum shop rating\nApplies to: Search Shops." }, "max_rating": { "title": "Max rating", "type": "number", "description": "Maximum shop rating\nApplies to: Search Shops." }, "min_sold_7d": { "title": "Min sold 7d", "type": "number", "description": "Minimum units sold over 7 days\nApplies to: Search Shops." }, "max_sold_7d": { "title": "Max sold 7d", "type": "number", "description": "Maximum units sold over 7 days\nApplies to: Search Shops." }, "min_gmv_7d": { "title": "Min gmv 7d", "type": "number", "description": "Minimum 7-day GMV in the selected market's local currency\nApplies to: Search Shops." }, "max_gmv_7d": { "title": "Max gmv 7d", "type": "number", "description": "Maximum 7-day GMV in the selected market's local currency\nApplies to: Search Shops." }, "sort": { "title": "Sort", "type": "string", "description": "Sort as field, field:asc or field:desc. A bare field uses descending order.\nApplies to: Search Shops; Most-Promoted Shops; Top-Selling Shops.\nAllowed fields — Search Shops: gmv_7d, product_count, rating, sold_7d, total_gmv, total_sold. Append :asc for ascending order." }, "date": { "title": "Date", "type": "string", "description": "Reporting date in YYYYMMDD format, for example 20261013. Use with granularity to select the reporting period; data availability varies by date.\nApplies to: Shop Market Concentration; Shop Market Overview; Most-Promoted Shops; Top-Selling Shops. Use YYYY-MM-DD or YYYYMMDD." }, "granularity": { "title": "Granularity", "enum": [ "daily", "weekly", "monthly" ], "type": "string", "description": "Reporting period: daily, weekly or monthly. Numeric aliases 0, 1 and 2 are also accepted. Pair with date.\nApplies to: Shop Market Concentration; Shop Market Overview; Most-Promoted Shops; Top-Selling Shops." }, "shop_type": { "title": "Shop type", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Shop type: 1 = overseas; 2 = local; 3 = brand; 4 = non-brand.\nApplies to: Most-Promoted Shops; Top-Selling Shops." } } }, "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 } } } } } } } } } }