{
"openapi": "3.0.1",
"info": {
"title": "TikTok Profile Scraper",
"description": "Extract data from TikTok profiles and videos they post. Get TikTok profile data, URLs, numbers of shares, followers, comments, hearts, video and music metadata. Export scraped data, run the scraper via API, schedule and monitor runs or integrate with other tools.",
"version": "0.0",
"x-build-id": "7xhGWMROLPgdKKUDB"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/clockworks~tiktok-profile-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-clockworks-tiktok-profile-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/clockworks~tiktok-profile-scraper/runs": {
"post": {
"operationId": "runs-sync-clockworks-tiktok-profile-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/clockworks~tiktok-profile-scraper/run-sync": {
"post": {
"operationId": "run-sync-clockworks-tiktok-profile-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": [
"profiles"
],
"properties": {
"profiles": {
"title": "Profile(s)",
"type": "array",
"description": "Add one or multiple TikTok usernames or user IDs you want to scrape. You can enter the usernames one by one, or use the Bulk edit section to add a prepared list.",
"items": {
"type": "string"
}
},
"profileScrapeSections": {
"title": "Profile sections to scrape",
"minItems": 1,
"uniqueItems": true,
"type": "array",
"description": "If a profile has reposted videos, you can scrape them by selecting 'Reposts'",
"items": {
"type": "string",
"enum": [
"videos",
"reposts"
],
"enumTitles": [
"Videos",
"Reposts"
]
},
"default": [
"videos"
]
},
"profileSorting": {
"title": "Profile video sorting",
"enum": [
"latest",
"popular",
"oldest"
],
"type": "string",
"description": "Select Latest to scrape the most recent videos first, Oldest - the oldest videos first, Popular - the most popular videos first. Date filters only work with Latest and Oldest. Only supported for Videos section",
"default": "latest"
},
"resultsPerPage": {
"title": "Max posts per profile",
"minimum": 1,
"type": "integer",
"description": "The number of posts that will be scraped from every profile.",
"default": 100
},
"oldestPostDateUnified": {
"title": "Scrape profile videos published after [date]",
"pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])(T[0-2]\\d:[0-5]\\d(:[0-5]\\d)?(\\.\\d+)?Z?)?$|^(\\d+)\\s*(minute|hour|day|week|month|year)s?$",
"type": "string",
"description": "Optional filter. Only videos uploaded after or on this date will be scraped. Alternatively, specify how old the scraped videos should be in days. Putting 1 will get you only today's posts, 2 - yesterday's and today's, and so on."
},
"newestPostDate": {
"title": "Scrape videos published before [date]",
"type": "string",
"description": "Optional filter. Only videos uploaded before or on this date will be scraped."
},
"mostDiggs": {
"title": "Scrape videos with number of hearts < [number]",
"minimum": 1,
"type": "integer",
"description": "Scrapes only videos with less hearts than the number you add. Doesn't work with date filters"
},
"leastDiggs": {
"title": "Scrape videos with number of hearts ≥ [number]",
"minimum": 1,
"type": "integer",
"description": "Scrapes only videos with no less hearts than the number you add. Doesn't work with date filters"
},
"maxFollowersPerProfile": {
"title": "🗂️ Maximum number of followers profiles",
"minimum": 0,
"type": "integer",
"description": "Optional charged filter. Scrapes only profiles with less followers than the number you add."
},
"maxFollowingPerProfile": {
"title": "🗂️ Maximum number of following profiles",
"minimum": 0,
"type": "integer",
"description": "Optional charged filter. Scrapes only profiles with less following profiles than the number you add."
},
"excludePinnedPosts": {
"title": "Exclude pinned posts",
"type": "boolean",
"description": "Tick to exclude pinned posts from profiles. Pinned posts are usually the first videos on a profile's page.",
"default": false
},
"shouldDownloadVideos": {
"title": "Include videos",
"type": "boolean",
"description": "Tick to download TikTok videos. Note that this will increase time and costs needed to extract the data.",
"default": false
},
"shouldDownloadCovers": {
"title": "Include thumbnails",
"type": "boolean",
"description": "Tick to download TikTok video cover images (thumbnails). Note that this will increase time and costs needed to extract the data.",
"default": false
},
"shouldDownloadSubtitles": {
"title": "Include subtitles",
"type": "boolean",
"description": "Tick to download TikTok video subtitles (only when present on the video). Note that this will increase time and costs needed to extract the data.",
"default": false
},
"shouldDownloadSlideshowImages": {
"title": "Download slideshow images",
"type": "boolean",
"description": "Tick to download TikTok slideshow images. Note that this will increase costs and time required for scraping.",
"default": false
},
"shouldDownloadAvatars": {
"title": "Include profile avatars",
"type": "boolean",
"description": "Tick to download authors' profile pictures. Note that this will increase time and costs needed to extract the data.",
"default": false
},
"videoKvStoreIdOrName": {
"title": "✍️ Name your storage for videos",
"pattern": "^[a-zA-Z0-9-]+$",
"type": "string",
"description": "Name (or ID) of the Key Value Store where the videos and other media like thumbnails will be stored. Omit to store in the default one. Using this option will provide a named Key-Value store can help bypass data retention and store the content forever until the store is manually deleted.
The Key-Value store's name can consist of a versatile combination of uppercase letters, lowercase letters, digits, or hyphens, all without any spaces."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}