{ "openapi": "3.0.1", "info": { "title": "TikTok Creator & Video Scraper", "description": "Enterprise-grade TikTok scraper that extracts 25+ data points per creator with built-in engagement analytics and video performance metrics. Perfect for influencer marketing, competitor analysis, and trend research.", "version": "1.0", "x-build-id": "dd88BKOK4mccp2czF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~tiktok-creator-video-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-tiktok-creator-video-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-video-scraper/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-tiktok-creator-video-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-video-scraper/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-tiktok-creator-video-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": { "scrapeType": { "title": "Scrape Type", "enum": [ "profiles", "hashtags", "sounds", "search" ], "type": "string", "description": "What to scrape from TikTok", "default": "profiles" }, "usernames": { "title": "Usernames", "type": "array", "description": "TikTok usernames to scrape (without @)", "items": { "type": "string" } }, "hashtags": { "title": "Hashtags", "type": "array", "description": "Hashtags to scrape videos from (without #)", "items": { "type": "string" } }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "Search terms to find creators or videos", "items": { "type": "string" } }, "sounds": { "title": "Sound IDs", "type": "array", "description": "TikTok sound/music IDs to scrape", "items": { "type": "string" } }, "includeVideos": { "title": "Include Videos", "type": "boolean", "description": "Scrape recent videos for each profile", "default": true }, "videosPerProfile": { "title": "Videos Per Profile", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of videos to scrape per profile", "default": 12 }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum items to return", "default": 50 }, "minFollowers": { "title": "Minimum Followers", "type": "integer", "description": "Only return profiles with at least this many followers", "default": 0 }, "minViews": { "title": "Minimum Views", "type": "integer", "description": "Only return videos with at least this many views", "default": 0 }, "sortBy": { "title": "Sort By", "enum": [ "followers", "likes", "views", "engagement", "recent" ], "type": "string", "description": "How to sort results", "default": "followers" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Required for TikTok - use residential proxies" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run with sample data. Set to false for real scraping.", "default": true }, "webhookUrl": { "title": "Webhook URL", "pattern": "^https?://.+", "type": "string", "description": "Optional webhook URL to receive results when scraping completes" }, "sessionCookies": { "title": "Session Cookies", "type": "string", "description": "JSON array of cookies exported from Cookie-Editor browser extension. Helps bypass TikTok login walls and CAPTCHAs. Log into TikTok, export cookies, then paste the JSON here." }, "cookieStorageKey": { "title": "Cookie Manager Storage Key", "type": "string", "description": "Key to load cookies from the Cookie Manager's Named KV Store. Use this instead of manually pasting sessionCookies. Run Cookie Manager in 'capture' mode first to store cookies, then reference the same storageKey here." }, "cookieKvStoreName": { "title": "Cookie KV Store Name", "type": "string", "description": "Name of the Named Key-Value Store where Cookie Manager saved the session. Defaults to 'cookie-sessions'.", "default": "cookie-sessions" } } }, "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 } } } } } } } } } }