{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Product Scraper - Units Sold, Price & Stock", "description": "For TikTok Shop sellers, brands and product researchers: paste product URLs or a store and get exact units sold, sale and list price, rating, reviews, stock per variant and the store. Monitoring mode returns only products whose sales or price changed since the last run.", "version": "0.1", "x-build-id": "tVXM6WI87Z4AgFg2p" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neverempty~tiktok-shop-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neverempty-tiktok-shop-product-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-product-scraper/runs": { "post": { "operationId": "runs-sync-neverempty-tiktok-shop-product-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-product-scraper/run-sync": { "post": { "operationId": "run-sync-neverempty-tiktok-shop-product-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": { "products": { "title": "TikTok Shop product URLs or product ids", "type": "array", "description": "Products to read: https://shop.tiktok.com/us/pdp//, https://www.tiktok.com/shop/pdp// (with or without the scheme), or the numeric product id (read as a US product). The product name part of the URL can be anything; the product id decides the product. A store URL pasted here is read as a store. A repeated product is read once and the repeat gets a free 'duplicate' row. Up to 500 entries per run (products and stores together). If you leave both lists out with monitoring off, two example products are read; with monitoring on, at least one list is required.", "items": { "type": "string" } }, "stores": { "title": "TikTok Shop store URLs or store ids (optional)", "type": "array", "description": "Stores whose best-selling products to read: https://shop.tiktok.com/us/store//, https://www.tiktok.com/shop/store//, or the numeric store id (read as a US store). The store's products are listed by units sold, highest first, and each one is read from its product page like the products above. A product that is also in the product list is read once.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Maximum products per store", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many products of each store are read, best-selling first. Each product read is one row. Has no effect on the product list.", "default": 20 }, "monitoringMode": { "title": "Monitoring mode: return a product only when it changed", "type": "boolean", "description": "Off = every product comes back with its current numbers, charged per row. On = the Actor remembers each product's units sold and price and, on later runs, returns a product only when it 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 (charged as rows, with no check fee). On later runs, a product that did not change is not returned and costs only the small per-product check fee shown on the Pricing tab. The Actor reads only as many products as the run's maximum total charge can pay a row for. Values are remembered per product; do not put the same product in two schedules that can run at the same time.", "default": false }, "changeOn": { "title": "In monitoring mode, return a product when", "enum": [ "units-sold-or-price", "units-sold", "price" ], "type": "string", "description": "units-sold-or-price = its units sold or its price changed (the default). units-sold = only its units sold changed. price = only its lowest or highest price changed. A product that is not returned keeps the values of the row last returned for it, so the next row's change is counted from that row.", "default": "units-sold-or-price" }, "resetMonitoringState": { "title": "Forget what was remembered and start over", "type": "boolean", "description": "Clears every remembered value for this Actor, so the next monitoring run returns each product once again as a first check. This affects all your monitoring runs, because values 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 } } } } } } } } } }