{ "openapi": "3.0.1", "info": { "title": "TikTok Scraper - Profiles, Videos, Hashtags & Sounds", "description": "Scrape TikTok at scale: user profiles & stats, video metadata, download URLs, hashtag feeds and sound feeds. Great for social listening, influencer research, trend tracking and lead generation.", "version": "1.0", "x-build-id": "uqU0OF780owLFuPBd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/trev0n~tiktok-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-trev0n-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/trev0n~tiktok-scraper/runs": { "post": { "operationId": "runs-sync-trev0n-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/trev0n~tiktok-scraper/run-sync": { "post": { "operationId": "run-sync-trev0n-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 (usernames or URLs)", "type": "array", "description": "TikTok usernames (with or without @) or profile URLs. By default the scraper returns each user's stats & bio. Set 'Profile scrape type' to 'posts' to fetch their video feed instead.", "items": { "type": "string" } }, "profileScrapeType": { "title": "Profile scrape type", "enum": [ "details", "posts" ], "type": "string", "description": "For the 'Profiles' input: 'details' returns follower/like/video counts & bio (fast, no browser). 'posts' loads each creator's video feed (uses the browser engine).", "default": "details" }, "postURLs": { "title": "Video URLs", "type": "array", "description": "TikTok video or photo URLs (or bare numeric IDs). Returns full video metadata, music, stats and download URLs.", "items": { "type": "string" } }, "hashtags": { "title": "Hashtags", "type": "array", "description": "Hashtag names (with or without #) or /tag/ URLs. Returns the videos posted under each hashtag / challenge.", "items": { "type": "string" } }, "musicURLs": { "title": "Sound / music URLs", "type": "array", "description": "TikTok music (sound) URLs or IDs. Returns the videos that use each sound.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (any TikTok URL)", "type": "array", "description": "Mixed list of TikTok URLs — profiles, videos, hashtags or sounds. Each is auto-classified. Use this instead of the typed inputs above if you already have URLs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "resultsPerPage": { "title": "Results per source", "minimum": 1, "type": "integer", "description": "Maximum videos/users to collect per profile feed, hashtag, sound or search query.", "default": 100 }, "maxItems": { "title": "Max results (total)", "minimum": 0, "type": "integer", "description": "Global cap across the whole run. 0 means unlimited.", "default": 1000 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many sources to process in parallel. Browser tasks are automatically kept to a lower concurrency.", "default": 8 }, "enableIncremental": { "title": "Incremental / monitoring mode", "type": "boolean", "description": "Only output NEW / UPDATED / REAPPEARED items vs. the previous run. Great for cheap recurring monitoring of a profile, hashtag or sound.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Name for the saved baseline. Leave empty to derive one from the first source. Use a stable key to monitor the same target over time." }, "emitUnchanged": { "title": "Emit unchanged items", "type": "boolean", "description": "Also output items whose content did not change since the last run.", "default": false }, "emitExpired": { "title": "Emit expired items", "type": "boolean", "description": "Output an EXPIRED record when a previously-seen item disappears from the source.", "default": false }, "skipReposts": { "title": "Skip reposts", "type": "boolean", "description": "Drop a NEW item whose content matches a recently expired one (same content, fresh ID).", "default": false }, "notifications": { "title": "Notifications", "type": "object", "description": "Optional webhook / Telegram / Discord / Slack ping when incremental mode finds new or updated items." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Leave on automatic: the scraper picks the right proxy tier per request (residential only where TikTok requires it). Set explicit groups or custom proxies to override for ALL requests.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }