{ "openapi": "3.0.1", "info": { "title": "🎵 TikTok Scraper - Videos, Profiles & Engagement Data", "description": "Scrape TikTok profiles, hashtags, search results, and video URLs. Extract video metadata, play counts, likes, shares, comments, author info, music data, and hashtags. Export to JSON, CSV, Excel, or XML. Supports date filtering, engagement filters, proxy rotation, and anti-detection.", "version": "1.0", "x-build-id": "dE9Bbm4SbvtTXzyTm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nourishing_courier~tiktok-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nourishing_courier-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/nourishing_courier~tiktok-scraper/runs": { "post": { "operationId": "runs-sync-nourishing_courier-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/nourishing_courier~tiktok-scraper/run-sync": { "post": { "operationId": "run-sync-nourishing_courier-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": "Profiles", "type": "array", "description": "List of TikTok profile usernames or URLs to scrape. Examples: 'charlidamelio', '@tiktok', 'https://www.tiktok.com/@charlidamelio'", "items": { "type": "string" } }, "hashtags": { "title": "Hashtags", "type": "array", "description": "List of hashtags to scrape videos from. Examples: 'trending', 'viral', '#fyp'. Tip: Use residential proxies for best hashtag results.", "items": { "type": "string" } }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "Search terms to find TikTok videos. Works best with multi-word queries. Examples: 'funny cats', 'cooking recipes', 'dance tutorial'", "items": { "type": "string" } }, "videoUrls": { "title": "Video URLs", "type": "array", "description": "Direct TikTok video URLs to scrape. Example: 'https://www.tiktok.com/@user/video/1234567890'", "items": { "type": "string" } }, "resultsPerPage": { "title": "Results Per Page", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of videos to extract per profile, hashtag, or search query. Higher values take longer and cost more.", "default": 50 }, "profileScrapeSections": { "title": "Profile Scrape Sections", "enum": [ "videos", "reposts", "likes" ], "type": "string", "description": "Which tab to scrape from profiles: their posted videos, reposted content, or liked videos.", "default": "videos" }, "profileSorting": { "title": "Profile Sorting", "enum": [ "latest", "popular", "oldest" ], "type": "string", "description": "How to sort videos from profile pages.", "default": "latest" }, "excludePinnedPosts": { "title": "Exclude Pinned Posts", "type": "boolean", "description": "Skip pinned posts when scraping profiles. Useful when you only want organic feed order.", "default": false }, "dateFrom": { "title": "Date From", "type": "string", "description": "Only include videos posted after this date. Format: YYYY-MM-DD (e.g., 2025-01-01)" }, "dateTo": { "title": "Date To", "type": "string", "description": "Only include videos posted before this date. Format: YYYY-MM-DD (e.g., 2025-12-31)" }, "minLikes": { "title": "Minimum Likes", "minimum": 0, "type": "integer", "description": "Only include videos with at least this many likes. Set to 0 or leave empty for no filter." }, "minViews": { "title": "Minimum Views", "minimum": 0, "type": "integer", "description": "Only include videos with at least this many views. Set to 0 or leave empty for no filter." }, "minComments": { "title": "Minimum Comments", "minimum": 0, "type": "integer", "description": "Only include videos with at least this many comments. Set to 0 or leave empty for no filter." }, "scrapeComments": { "title": "Scrape Comments", "type": "boolean", "description": "Extract comments from videos (increases run time and cost).", "default": false }, "commentsPerVideo": { "title": "Comments Per Video", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of comments to extract per video when comment scraping is enabled.", "default": 100 }, "downloadVideos": { "title": "Download Videos", "type": "boolean", "description": "Download video files to the Key-Value Store (significantly increases run time and storage cost).", "default": false }, "downloadSubtitles": { "title": "Download Subtitles", "type": "boolean", "description": "Download subtitle/caption files if available.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Residential proxies are recommended for hashtag and search scraping. Profile and video scraping works without proxies." }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of browser pages running in parallel. Higher values are faster but use more memory. Reduce if you see memory errors.", "default": 3 } } }, "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 } } } } } } } } } }