{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Videos Scraper — Affiliate Video Transcripts", "description": "TikTok Shop affiliate videos with what they say: paste a product link and get the videos selling it — creator, views, likes, caption, hashtags, posted date — each with a transcript from TikTok's own captions or speech-to-text, plus the product's price, units sold and shop. US shop.", "version": "1.0", "x-build-id": "oLJ2pjaFBosggrSIH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/steadyfetch~tiktok-shop-video-scripts-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-steadyfetch-tiktok-shop-video-scripts-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/steadyfetch~tiktok-shop-video-scripts-scraper/runs": { "post": { "operationId": "runs-sync-steadyfetch-tiktok-shop-video-scripts-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/steadyfetch~tiktok-shop-video-scripts-scraper/run-sync": { "post": { "operationId": "run-sync-steadyfetch-tiktok-shop-video-scripts-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": [ "products" ], "properties": { "products": { "title": "TikTok Shop products", "type": "array", "description": "TikTok Shop product links, one per line — https://www.tiktok.com/shop/pdp// or https://shop.tiktok.com/view/product/ — or the product id alone (the long number at the end of the link). US TikTok Shop only in this version: a link to another country's shop, a short share link, a video link or anything else is refused on its own uncharged row that says why. \"_demo\" is the sample switch, not a product. Leave it empty in the console and the run returns built-in sample rows instead of reading anything, so you can see the output shape at no result fee.", "default": [ "_demo" ], "items": { "type": "string" } }, "maxVideosPerProduct": { "title": "Max videos per product", "minimum": 1, "type": "integer", "description": "Hard cap on the affiliate videos returned for each product (default 20, which is about what a product page lists). A product listing fewer says so on its product row, uncharged. Ask for more than 20 and the run still starts: it continues at 20, with one uncharged row saying what was asked and what bound it.", "default": 20 }, "transcripts": { "title": "Include transcripts", "type": "boolean", "description": "ON (default) adds what each video says — `transcript.text`, `transcript.source` (captions or speech) and timestamped `transcript.segments`. TikTok's own captions are used when the video has them (most do, at any length); otherwise the words are read from the audio for videos up to 2 minutes and 12 MB. Charged as one transcript per video whose words were actually produced: $0.015 on the Apify free plan, $0.014 on Bronze, $0.0075 on Silver and above. A video with no speech, a longer uncaptioned video and a video your account already has are delivered without a transcript, and no transcript is charged. OFF: rows carry the caption text, counts and links only.", "default": true }, "newVideosOnly": { "title": "New videos only", "type": "boolean", "description": "ON (default): every run remembers, per product, the videos it delivered to your Apify account, and a later run skips them and never charges for them again — so a weekly schedule pays only for what is new, and a product whose page shows nothing new costs one $0.0065 check. OFF: videos you already have are handed back too, marked repeat, uncharged and without a new transcript.", "default": true }, "maxRunSeconds": { "title": "Max run seconds", "type": "integer", "description": "The run stops cleanly before this many seconds and reports what is left, instead of being killed by a timeout. A time limit ends the collecting, never the delivering: videos already in hand are always written out. With transcripts on, budget roughly 3-6 seconds per video. Anything outside the actor's own range of 60 to 3,600 seconds still starts a run: the clock is set to the nearest end of that range and one uncharged row says so.", "default": 1800 } } }, "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 } } } } } } } } } }