{ "openapi": "3.0.1", "info": { "title": "TikTok Video Scraper: Post Stats, Transcripts", "description": "Scrape TikTok videos by URL, one row per link in your order, no login: play, like, comment, share, save and repost counts, caption, hashtags, mentions, music, author stats at post time, content categories, related searches, media URLs with expiry and the ASR transcript inline. Pay per post.", "version": "0.1", "x-build-id": "QOvDSfDAX86rF5FPx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation_craft~tiktok-video-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation_craft-tiktok-video-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/automation_craft~tiktok-video-scraper/runs": { "post": { "operationId": "runs-sync-automation_craft-tiktok-video-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/automation_craft~tiktok-video-scraper/run-sync": { "post": { "operationId": "run-sync-automation_craft-tiktok-video-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": { "postUrls": { "title": "TikTok post URLs, short links or post ids", "type": "array", "description": "One value per line. Accepts www.tiktok.com/@user/video/ID and /photo/ID URLs, vm.tiktok.com and vt.tiktok.com short links, m.tiktok.com/v/ID.html links and bare numeric post ids. Every value gets exactly one row, in the order given; duplicates, profile URLs and anything that is not a post get a free status row.", "items": { "type": "string" } }, "maxPosts": { "title": "Maximum posts", "minimum": 0, "type": "integer", "description": "Stop after this many posts are delivered. Values after the cap are not fetched and get a free status row with status skipped. 0 means no cap." }, "includeRenditions": { "title": "Include every video rendition", "type": "boolean", "description": "Free. When on, videoMeta.renditions lists every rendition TikTok serves (quality, bitrate, codec, size and URL). When off, only the largest rendition is kept so rows stay small; videoMeta.renditionCount still says how many exist." }, "includeTranscript": { "title": "Include the transcript", "type": "boolean", "description": "Free. Downloads the automatic caption track TikTok serves with the post and returns the text inline plus timed segments. Posts without a track get a transcriptReason instead (no_captions, captions_disabled, slideshow, download_failed)." }, "transcriptLanguage": { "title": "Transcript language", "type": "string", "description": "Optional language code such as en, es or pt. When the post has a caption track in that language it is used; otherwise the original language track is returned and transcriptLanguageRequested records what you asked for. Leave empty for the original language." }, "excludeAds": { "title": "Exclude ads", "type": "boolean", "description": "Free filter. Posts TikTok marks as ads get a free status row with status filtered instead of a paid row." }, "slideshowsOnly": { "title": "Slideshows only", "type": "boolean", "description": "Free filter. Deliver only photo slideshow posts; videos get a free status row with status filtered." }, "memoryName": { "title": "Memory name", "type": "string", "description": "Optional. A name for a memory kept between runs: a post already delivered under this name is not fetched again and gets a free status row with status already_known. If the memory cannot be opened or saved, posts are delivered free and a status row says so." }, "resetMemory": { "title": "Reset the memory", "type": "boolean", "description": "Forget every post stored under the memory name before this run starts." }, "tryDirectFirst": { "title": "Try the platform IP first", "type": "boolean", "description": "When on, the first request for each post goes straight from the Apify platform and every retry goes through the proxy below on a fresh session. Measured on Apify: the platform IP answered every post page on the first try and twice as fast. Turn off to send every request through the proxy." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "The proxy used for retries (and for every request when the option above is off). Apify datacenter proxy by default; no residential proxy is needed." }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many posts are fetched at the same time, 1 to 8. Rows are still written in your order." } } }, "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 } } } } } } } } } }