{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Sales Scraper: Units Sold & Revenue", "description": "Most TikTok Shop scrapers return a catalogue. This one returns sales: lifetime units sold and estimated revenue on every product, plus units per day and growth percent calculated from a daily history we keep, so the figures are there on your first run. US market. No login or proxy", "version": "0.0", "x-build-id": "0Lw50wLbzzWsX6z4P" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~tiktok-shop-sales-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-tiktok-shop-sales-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/memo23~tiktok-shop-sales-scraper/runs": { "post": { "operationId": "runs-sync-memo23-tiktok-shop-sales-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/memo23~tiktok-shop-sales-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-tiktok-shop-sales-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", "required": [ "keywords" ], "properties": { "keywords": { "title": "Search keywords", "type": "array", "description": "Product terms to search TikTok Shop for, such as \"stanley tumbler\", \"lash serum\" or \"led strip lights\". Each keyword returns matching products with the number of units sold, so you can see what is actually selling rather than what is merely listed.", "items": { "type": "string" } }, "maxResultsPerKeyword": { "title": "Maximum products per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop after this many products for each keyword. One upstream search page returns roughly 30 to 45 products, so going beyond that needs more pages below.", "default": 50 }, "maxPagesPerKeyword": { "title": "Search pages per keyword", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many search pages to walk for each keyword. Each page costs one upstream request and pages overlap heavily, so page 2 typically adds only about half a page of genuinely new products. The walk stops early on its own once a page brings nothing new.", "default": 3 }, "minSoldCount": { "title": "Minimum units sold", "minimum": 0, "type": "integer", "description": "Skip products below this many lifetime units sold. Set to 1 or higher to drop listings that have never sold, or to something like 500 to see only proven movers.", "default": 0 }, "sortBySales": { "title": "Sort by units sold", "type": "boolean", "description": "Return the best-selling products first instead of TikTok's own search order.", "default": true }, "includeSalesTrend": { "title": "Include sales trend", "type": "boolean", "description": "Add units sold in the recent window, units per day and growth percent, calculated from our own daily history of each product. Products seen for the first time have no history yet, so their trend fields stay empty until the next run.", "default": true }, "trendLookbackDays": { "title": "Trend window (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "How far back to compare against when calculating the trend. If a product has less history than this, the trend is calculated over the span that does exist and the actual span is reported in trendWindowDays.", "default": 7 } } }, "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 } } } } } } } } } }