{ "openapi": "3.0.1", "info": { "title": "TikTok Scraper & Downloader Pro", "description": "Scrape TikTok at scale: full profiles with videos and stats, hashtag feeds, single-post details, comments and no-watermark video URLs. Filter by date and likes, download media, export JSON/CSV. Output matches clockworks/tiktok-scraper format, so your existing integrations keep working.", "version": "0.4", "x-build-id": "fEY9yo8XYvhZ1xMsm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/centered_quaff~tiktok-scraper-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-centered_quaff-tiktok-scraper-pro", "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/centered_quaff~tiktok-scraper-pro/runs": { "post": { "operationId": "runs-sync-centered_quaff-tiktok-scraper-pro", "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/centered_quaff~tiktok-scraper-pro/run-sync": { "post": { "operationId": "run-sync-centered_quaff-tiktok-scraper-pro", "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": { "profiles": { "title": "Profiles", "type": "array", "description": "TikTok usernames (without @) or profile URLs to scrape, e.g. khaby.lame", "items": { "type": "string" } }, "hashtags": { "title": "Hashtags", "type": "array", "description": "Hashtags to scrape, e.g. fyp", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Keyword search queries. Returns videos and profiles matching the query", "items": { "type": "string" } }, "searchSection": { "title": "Search section", "enum": [ "", "video", "profile" ], "type": "string", "description": "Apply search to Top results, only videos, or only profiles", "default": "" }, "maxProfilesPerQuery": { "title": "Max profiles per query", "minimum": 0, "maximum": 100, "type": "integer", "description": "Maximum number of profiles to scrape per search query", "default": 10 }, "postURLs": { "title": "Video URLs", "type": "array", "description": "TikTok video URLs or vm.tiktok.com short links", "items": { "type": "string" } }, "musicURLs": { "title": "Music URLs / IDs", "type": "array", "description": "TikTok music IDs or music page URLs to scrape videos for", "items": { "type": "string" } }, "resultsPerPage": { "title": "Results per input", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Number of videos to scrape per profile/hashtag/query/music", "default": 30 }, "profileScrapeSections": { "title": "Profile scrape sections", "type": "array", "description": "Sections of the profile to scrape (currently: videos)", "items": { "type": "string", "enum": [ "videos", "reposts", "stories" ], "enumTitles": [ "Videos", "Reposts", "Stories" ] }, "default": [ "videos" ] }, "profileSorting": { "title": "Profile sorting", "enum": [ "latest", "oldest", "popular" ], "type": "string", "description": "Order of profile videos: latest, oldest or popular", "default": "latest" }, "excludePinnedPosts": { "title": "Exclude pinned posts", "type": "boolean", "description": "Skip pinned posts from profiles and hashtags", "default": false }, "oldestPostDateUnified": { "title": "Oldest post date", "type": "string", "description": "Only videos uploaded on or after this date (ISO, e.g. 2026-01-01)" }, "newestPostDate": { "title": "Newest post date", "type": "string", "description": "Only videos uploaded on or before this date (ISO, e.g. 2026-09-01)" }, "mostDiggs": { "title": "Max likes (mostDiggs)", "minimum": 0, "type": "integer", "description": "Skip videos with more likes than this number. 0 = disabled" }, "leastDiggs": { "title": "Min likes (leastDiggs)", "minimum": 0, "type": "integer", "description": "Skip videos with fewer likes than this number. 0 = disabled" }, "commentsPerPost": { "title": "Comments per post", "minimum": 0, "maximum": 100, "type": "integer", "description": "Extract this many comments for each scraped video", "default": 0 }, "proxyCountryCode": { "title": "Proxy country", "type": "string", "description": "Country for Apify Proxy geo-targeting, e.g. US, DE, TR. Use None for automatic" }, "msToken": { "title": "msToken (optional)", "type": "string", "description": "Optional: paste a real msToken cookie from your browser (tiktok.com -> DevTools -> Application -> Cookies -> msToken). Improves search reliability." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings. Residential proxy is recommended for comments, search and large runs" }, "shouldDownloadVideos": { "title": "Download videos", "type": "boolean", "description": "Save no-watermark MP4 files to the Key-Value store", "default": false }, "shouldDownloadCovers": { "title": "Download covers", "type": "boolean", "description": "Save video cover images to the Key-Value store", "default": false }, "shouldDownloadAvatars": { "title": "Download avatars", "type": "boolean", "description": "Save profile avatars to the Key-Value store", "default": false }, "shouldDownloadSlideshowImages": { "title": "Download slideshow images", "type": "boolean", "description": "Save photo-mode slideshow images to the Key-Value store", "default": false }, "shouldDownloadMusicCovers": { "title": "Download music covers", "type": "boolean", "description": "Save sound cover images to the Key-Value store", "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 } } }, "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 } } } } } } } } } }