{
"openapi": "3.0.1",
"info": {
"title": "TikTok Profile Scraper (Pay Per Result)",
"description": "Scrape TikTok profiles by username: followers, bio, bio link, verified badge, TikTok Shop seller flag and category, avatar, plus latest posts with full metadata. No proxies needed, explicit not-found entries, batch up to 1000 handles. Compatible output with popular profile scrapers.",
"version": "0.1",
"x-build-id": "zCBlYhi51LGuSG8eJ"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/xmolodtsov~tiktok-profile-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-xmolodtsov-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/xmolodtsov~tiktok-profile-scraper/runs": {
"post": {
"operationId": "runs-sync-xmolodtsov-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/xmolodtsov~tiktok-profile-scraper/run-sync": {
"post": {
"operationId": "run-sync-xmolodtsov-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": "TikTok profiles",
"type": "array",
"description": "TikTok usernames to scrape, without the @ (bare handles, @handle and full profile URLs are all accepted). Batch many handles into one run for the best cost efficiency — up to 1000 per run.",
"items": {
"type": "string"
}
},
"resultsPerPage": {
"title": "Posts per profile",
"minimum": 0,
"maximum": 3000,
"type": "integer",
"description": "How many latest posts to return per profile. Each post is one paid result and carries the full author block (authorMeta).
Set to 0 for profile-only mode: one compact item per handle with just the author block — the cheapest way to get profile metadata."
},
"profileScrapeSections": {
"title": "Profile sections",
"type": "array",
"description": "Which profile sections to scrape. Only videos is supported.",
"items": {
"type": "string",
"enum": [
"videos"
],
"enumTitles": [
"Videos"
]
},
"default": [
"videos"
]
},
"profileSorting": {
"title": "Post sorting",
"enum": [
"latest"
],
"type": "string",
"description": "Order of returned posts. Posts are returned newest-first (latest).",
"default": "latest"
},
"excludePinnedPosts": {
"title": "Exclude pinned posts",
"type": "boolean",
"description": "If enabled, pinned posts are filtered out of the results.",
"default": false
},
"oldestPostDate": {
"title": "Oldest post date",
"type": "string",
"description": "Only return posts created on/after this date (ISO format, e.g. 2024-01-01)."
},
"shouldDownloadVideos": {
"title": "Download videos",
"type": "boolean",
"description": "Accepted for input compatibility, but this actor never downloads media — it returns TikTok CDN URLs instead, which is what keeps the per-result price low.",
"default": false
},
"shouldDownloadCovers": {
"title": "Download covers",
"type": "boolean",
"description": "Accepted for compatibility — media is never downloaded, CDN URLs are returned.",
"default": false
},
"shouldDownloadSlideshowImages": {
"title": "Download slideshow images",
"type": "boolean",
"description": "Accepted for compatibility — media is never downloaded, CDN URLs are returned.",
"default": false
},
"shouldDownloadAvatars": {
"title": "Download avatars",
"type": "boolean",
"description": "Accepted for compatibility — media is never downloaded, CDN URLs are returned.",
"default": false
},
"shouldDownloadMusicCovers": {
"title": "Download music covers",
"type": "boolean",
"description": "Accepted for compatibility — media is never downloaded, CDN URLs are returned.",
"default": false
},
"downloadSubtitlesOptions": {
"title": "Subtitle download options",
"enum": [
"NEVER_DOWNLOAD_SUBTITLES"
],
"type": "string",
"description": "Accepted for compatibility — subtitle CDN links are always included in videoMeta.subtitleLinks when TikTok provides them.",
"default": "NEVER_DOWNLOAD_SUBTITLES"
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Optional override. By default the actor uses its own built-in proxy pool — you don't need to configure anything."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}