{ "openapi": "3.0.1", "info": { "title": "TikTok Creator & Video Scraper", "description": "Scrape TikTok creator profiles and their recent videos to extract profile data, video cover images, engagement metrics, hashtag usage, and aggregate analytics.\nBuilt with richer output including cover image URLs (for photo harvesting), per-video engagement stats, and aggregate content analytics.", "version": "1.0", "x-build-id": "xdmaazpkvBJ4TzHBK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~tiktok-creator-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-tiktok-creator-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/alizarin_refrigerator-owner~tiktok-creator-scraper/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-tiktok-creator-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/alizarin_refrigerator-owner~tiktok-creator-scraper/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-tiktok-creator-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": "List of TikTok profile URLs or usernames to scrape. Accepts full URLs (https://www.tiktok.com/@username) or just the username (with or without @).", "items": { "type": "string" } }, "maxVideos": { "title": "Max Videos Per Profile", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of recent videos to scrape per profile. More videos = longer run time. Cover images are extracted from each video card.", "default": 30 }, "includeAnalytics": { "title": "Include Aggregate Analytics", "type": "boolean", "description": "Calculate and include aggregate analytics: average views/likes/comments/shares per video, engagement rate, top hashtags, and content type breakdown.", "default": true }, "cookieStorageKey": { "title": "Cookie Storage Key", "type": "string", "description": "Key name in the Cookie Manager KV store to load session cookies from. TikTok works better when logged in. Run Cookie Manager in capture mode first to save your cookies." }, "cookieKvStoreName": { "title": "Cookie KV Store Name", "type": "string", "description": "Name of the Apify Named Key-Value Store where cookies are stored. Must match the store used by Cookie Manager.", "default": "cookie-sessions" }, "sessionCookies": { "title": "Manual Session Cookies (JSON)", "type": "string", "description": "Raw JSON array of cookies from Cookie-Editor browser extension. Takes priority over Cookie Manager KV store. Format: [{\"name\":\"...\",\"value\":\"...\",\"domain\":\".tiktok.com\",...}]" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Residential proxies are strongly recommended for TikTok to avoid blocks.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run in demo mode without real scraping. Returns realistic sample data for a fictional TikTok creator with 20 sample videos including cover image URLs. Great for testing integrations.", "default": false }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "URL to POST results when scraping completes (Zapier, Make, n8n, custom endpoint)." } } }, "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 } } } } } } } } } }