{ "openapi": "3.0.1", "info": { "title": "TikTok User Profile Scraper With Engagement Analytics", "description": "📱 TikTok User Profile Scraper extracts profile data at scale — username, bio, followers, following, likes, link, avatar, and recent videos with engagement. 🚀 Ideal for influencer discovery, competitor research, lead gen & social analytics. 📊 Fast, accurate, CSV/JSON-ready.", "version": "0.1", "x-build-id": "rUbV4LAClAufnDOZF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~tiktok-user-profile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-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/scraper-engine~tiktok-user-profile-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-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/scraper-engine~tiktok-user-profile-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-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": "🔑 Creator user ID(s)", "type": "array", "description": "📋 Long number IDs only (digits as text). 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. Leave empty when handles or IDs are enough.", "items": { "type": "string" } }, "trackGrowth": { "title": "📈 Track growth across runs", "type": "boolean", "description": "✅ ON: each creator's follower/following/likes/video counts are compared to their previous run and Δ fields are added to the row. A creator's first-ever run has no baseline yet, so the Δ fields come back null that time — from the SECOND run onward they show a real number (including 0 if nothing changed). Turn OFF to skip saving/comparing snapshots entirely.", "default": true }, "resetGrowthBaseline": { "title": "♻️ Restart growth tracking for these creators", "type": "boolean", "description": "🗑️ ON: this run's counts become the new starting point for every creator in this run — their Δ fields on THIS row come back null, as if it were their first run, and future runs compare against today's numbers instead of the old snapshot.", "default": false }, "maxRetries": { "title": "🔁 Max retries per creator", "minimum": 0, "maximum": 10, "type": "integer", "description": "🔄 How many times to retry a single profile fetch after a network hiccup before giving up on that creator.", "default": 3 }, "requestGapMs": { "title": "⏳ Delay between creators (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "🐢 Pause between fetching each creator, in milliseconds — helps large batches run smoothly.", "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 } } } } } } } } } }