{ "openapi": "3.0.1", "info": { "title": "TikTok Metrics Scraper - Video & Profile Stats", "description": "Scrape public TikTok video and profile metrics from video URLs, share links, profile URLs, and @handles. Collect views, likes, comments, shares, saves, reposts, profile stats, IDs, captions, hashtags, music, timestamps, precision labels, provenance, and clean CSV/API rows.", "version": "0.1", "x-build-id": "zowXlWpAubFWigtU5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/chronometrica~tiktok-metrics-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-chronometrica-tiktok-metrics-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/chronometrica~tiktok-metrics-scraper/runs": { "post": { "operationId": "runs-sync-chronometrica-tiktok-metrics-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/chronometrica~tiktok-metrics-scraper/run-sync": { "post": { "operationId": "run-sync-chronometrica-tiktok-metrics-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": { "mode": { "title": "Input handling", "enum": [ "auto", "knownUrls", "profileUrls" ], "type": "string", "description": "Choose how to use the inputs below. Auto-detect accepts video URLs, profile URLs, and @handles in the same list.", "default": "auto" }, "startUrls": { "title": "TikTok URLs or @handles", "minItems": 0, "uniqueItems": true, "type": "array", "description": "Paste public TikTok video URLs, mobile/share URLs, profile URLs, or @handles. The actor combines direct videos and discovered profile videos, deduplicates them, and applies one shared metric row cap.", "items": { "type": "string", "pattern": "^\\s*(?:(?:https?:\\/\\/)?(?:(?:www\\.|m\\.|vm\\.|vt\\.)?tiktok\\.com)\\/\\S+|@[A-Za-z0-9._-]+|[A-Za-z0-9._-]+)\\s*$" }, "default": [ "https://www.tiktok.com/@mrbeast/video/7654638524729216287" ] }, "urls": { "title": "Legacy video URLs", "type": "array", "description": "Backward-compatible hidden field for API users that send known TikTok video URLs as urls.", "items": { "type": "string" }, "default": [] }, "profileUrls": { "title": "Legacy profile URLs", "type": "array", "description": "Backward-compatible hidden field for API users that send TikTok profile URLs or @handles as profileUrls.", "items": { "type": "string" }, "default": [] }, "maxItems": { "title": "Metric rows to collect (shared cap)", "minimum": 1, "type": "integer", "description": "Maximum number of video metric rows to collect across direct video URLs and videos discovered from profiles.", "default": 25 }, "maxItemsPerProfile": { "title": "Videos to discover per profile", "minimum": 1, "type": "integer", "description": "Maximum number of public video URLs to discover from each TikTok profile URL or @handle. The shared cap still limits total output rows.", "default": 20 }, "includeProfileMetrics": { "title": "Add profile metrics", "type": "boolean", "description": "Add best-effort public profile follower, following, total likes, and video counts when TikTok exposes them in public page data.", "default": true }, "includeAuthorProfileMetrics": { "title": "Legacy profile metrics flag", "type": "boolean", "description": "Backward-compatible hidden field for API users that send includeAuthorProfileMetrics." }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 5, "type": "integer", "description": "Maximum seconds to wait for each public TikTok request.", "default": 20 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "type": "integer", "description": "Maximum number of TikTok URLs to resolve at the same time.", "default": 3 }, "failOnNoMetrics": { "title": "Fail when no metrics are exposed", "type": "boolean", "description": "Fail the run if none of the input URLs expose public metrics. Individual URLs without metrics still emit rows with structured statuses.", "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 } } } } } } } } } }