{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Store Scraper - Exact Units Sold Tracker", "description": "For TikTok Shop sellers, brands and product researchers: every product of a store with exact units sold, price, rating and reviews. Goli's top gummy shows 1.3M sold; this returns 1,302,692. Track several stores and get only the products that sold since the last run.", "version": "0.1", "x-build-id": "GxGyDPoTa5hD9OhoR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neverempty~tiktok-shop-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neverempty-tiktok-shop-store-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/neverempty~tiktok-shop-store-scraper/runs": { "post": { "operationId": "runs-sync-neverempty-tiktok-shop-store-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/neverempty~tiktok-shop-store-scraper/run-sync": { "post": { "operationId": "run-sync-neverempty-tiktok-shop-store-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": { "stores": { "title": "TikTok Shop store URLs or store ids", "type": "array", "description": "Stores to read: https://shop.tiktok.com/us/store/goli-nutrition/7495794203056835079, https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079 (with or without the scheme), or the numeric store id (read as a US store). The store name part of the URL can be anything; the store id decides the store. A repeated store is read once and the repeat gets a free 'duplicate' row. Up to 100 stores per run. If you leave this field out with monitoring off, two example stores are read; with monitoring on it is required. An empty list is rejected.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Maximum products per store", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many products of each store are read, best-selling first (TikTok lists a store's products by units sold, highest first). With monitoring off, each product read is one charged row. In monitoring mode this many products of each store are checked, and every one of them whose units sold changed is returned. Products are read 20 at a time.", "default": 100 }, "monitoringMode": { "title": "Monitoring mode: return a product only when its units sold change", "type": "boolean", "description": "Off = every product comes back with its current units sold, charged per row. On = the Actor remembers each product's units sold and, on later runs, returns a product only when its units sold changed since the row last returned for it, with the units sold in between and the hours between the two readings. The first run returns every product once to set the baseline. **In monitoring mode every product whose units sold are read costs $0.30 per 1,000 checks, changed or not**, plus the row price for the rows returned. Example: 2 stores x 100 products every 6 hours = 24,000 checks a month = $7.20 plus the changed rows. The Actor reads only as many products as the run's maximum total charge can pay for with a check and a change row each. Units sold are remembered per product; do not put the same store in two schedules that can run at the same time.", "default": false }, "changeOn": { "title": "In monitoring mode, return a product when", "enum": [ "units-sold", "units-sold-or-price" ], "type": "string", "description": "units-sold = only when its units sold changed (the default). units-sold-or-price = also when only its price changed. A product that is not returned keeps the units sold and price of the row last returned for it, so the next row's units sold since the previous row add up from there.", "default": "units-sold" }, "resetMonitoringState": { "title": "Forget what was remembered and start over", "type": "boolean", "description": "Clears every remembered units-sold count for this Actor, so the next monitoring run returns each product once again as a first check. This affects all your monitoring runs, because counts are stored per product rather than per list. Turn it off again after one run: left on in a schedule, every run returns every product as a first check and charges the row price for it.", "default": false } } }, "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 } } } } } } } } } }