{ "openapi": "3.0.1", "info": { "title": "TikTok User Profile and Video Insights Scraper", "description": "Scrape TikTok user profiles and video insights, including usernames, bios, followers, likes, video views, captions, hashtags, engagement metrics, and posting details. Ideal for creator research, competitor analysis, content trends, and audience insights.", "version": "0.1", "x-build-id": "bHUR5hshPWDka8WXi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapier~tiktok-user-profile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapier-tiktok-user-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/scrapier~tiktok-user-profile-scraper/runs": { "post": { "operationId": "runs-sync-scrapier-tiktok-user-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/scrapier~tiktok-user-profile-scraper/run-sync": { "post": { "operationId": "run-sync-scrapier-tiktok-user-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", "properties": { "usernames": { "title": "👤 Creator handle(s)", "type": "array", "description": "🎪 One handle per line (examples: nike, @nike). Leave blank if you use IDs or URLs instead.", "items": { "type": "string" } }, "userIds": { "title": "🔑 Numeric user ID(s)", "type": "array", "description": "📋 Digits-as-text IDs only. Skip this section if you're using handles or profile URLs.", "items": { "type": "string" } }, "urls": { "title": "🔗 Profile link(s)", "type": "array", "description": "🎬 Paste TikTok profile links here. Optional when handles or IDs are enough.", "items": { "type": "string" } }, "includeRecentVideos": { "title": "🎞️ Fetch each creator's recent videos", "type": "boolean", "description": "Turn OFF to collect only the profile row (fastest, base-equivalent behavior).", "default": true }, "maxVideosPerProfile": { "title": "📊 Max videos per creator", "minimum": 0, "maximum": 50, "type": "integer", "description": "🎯 Cap on how many of the newest videos to fetch PER creator. This does NOT reduce how many creator profiles are collected — profiles and videos are counted separately. Example: 10 → up to 10 video rows per creator, however many creators you added. Default 10, max 50.", "default": 10 }, "maxRetries": { "title": "🔁 Max retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "Per-request retries on network errors, applied to both the profile fetch and the video fetch. Default 3.", "default": 3 }, "requestGapMs": { "title": "⏱️ Delay between creators (ms)", "minimum": 0, "type": "integer", "description": "Pause between each creator's fetch, in milliseconds. Default 750.", "default": 750 }, "proxyConfiguration": { "title": "🛡️ Connection & privacy (optional)", "type": "object", "description": "⚙️ Standard Apify Proxy picker — choose groups or turn off if you don't need it." } } }, "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 } } } } } } } } } }