{ "openapi": "3.0.1", "info": { "title": "TikTok Scraper — Videos, Profiles & Engagement Analytics", "description": "Scrape TikTok profiles and videos: captions, stats, hashtags, engagement rate, virality score, sponsorship detection and watermark-free download links. Export to CSV, Excel, JSON.", "version": "0.1", "x-build-id": "vPpCMj6AGdBGaUUet" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/punkrecordsdata~tiktok-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-punkrecordsdata-tiktok-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/punkrecordsdata~tiktok-scraper/runs": { "post": { "operationId": "runs-sync-punkrecordsdata-tiktok-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/punkrecordsdata~tiktok-scraper/run-sync": { "post": { "operationId": "run-sync-punkrecordsdata-tiktok-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": { "profiles": { "title": "👤 TikTok profiles", "type": "array", "description": "Usernames (with or without @) or full profile URLs. The Actor pulls each profile's most recent videos. Example: `tiktok`, `@nike`, or `https://www.tiktok.com/@nike`.", "items": { "type": "string" } }, "postURLs": { "title": "🔗 Direct video URLs", "type": "array", "description": "Full TikTok video links to scrape individually, e.g. `https://www.tiktok.com/@user/video/1234567890123456789`. Matched against the author's most recent uploads — a very old video may not be found; for deep history use **TikTok profiles** with a higher **Videos per profile** instead.", "items": { "type": "string" } }, "resultsPerPage": { "title": "🎞️ Videos per profile", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many recent videos to pull from each profile listed above." }, "maxItems": { "title": "🔢 Max results (total)", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Hard cap across every profile and video combined, so a run never runs longer or costs more than you expect. **Free plan:** capped at 10 regardless of this value. **Paid:** up to 1,000,000." }, "excludePinnedPosts": { "title": "📌 Exclude pinned posts", "type": "boolean", "description": "Skip videos pinned to the top of a profile, so they don't push out fresher content when you only want the latest.", "default": false }, "oldestPostDate": { "title": "📅 Oldest post date", "type": "string", "description": "Only keep videos posted on or after this date. Format: `YYYY-MM-DD`." }, "newestPostDate": { "title": "📅 Newest post date", "type": "string", "description": "Only keep videos posted on or before this date. Format: `YYYY-MM-DD`." }, "scrapeAdditionalAuthorMeta": { "title": "👥 Scrape full author stats", "type": "boolean", "description": "Add each video's author's follower count, following count, total hearts and video count. Costs one extra request per unique author, worth it for influencer vetting or engagement-ratio analysis.", "default": true }, "detectSponsoredContent": { "title": "💰 Detect sponsored content", "type": "boolean", "description": "Flag videos as likely sponsored/ads based on caption signals (`#ad`, `#sponsored`, \"paid partnership\", etc.) — handy for compliance and disclosure audits.", "default": true }, "proxyConfiguration": { "title": "🌐 Proxy configuration", "type": "object", "description": "TikTok blocks datacenter IPs at scale — **Residential** is required for reliable results and is already selected below.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }