{ "openapi": "3.0.1", "info": { "title": "Tiktok Data Extractor Scraper", "description": "๐ŸŽต TikTok Data Extractor Scraper collects profiles, videos, hashtags & commentsโ€”captions, sounds, views, likes, shares, timestamps & engagement. ๐Ÿ”Ž Ideal for influencer discovery, trend tracking & competitor analysis. ๐Ÿ“Š Fast, scalable exports to CSV/JSON. ๐Ÿš€", "version": "0.1", "x-build-id": "iHEn7B9uv4a8fkHvs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraperx~tiktok-data-extractor-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraperx-tiktok-data-extractor-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/scraperx~tiktok-data-extractor-scraper/runs": { "post": { "operationId": "runs-sync-scraperx-tiktok-data-extractor-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/scraperx~tiktok-data-extractor-scraper/run-sync": { "post": { "operationId": "run-sync-scraperx-tiktok-data-extractor-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": { "hashtags": { "title": "#๏ธโƒฃ Videos with this hashtag", "type": "array", "description": "Just add one or more TikTok hashtags and the scraper will collect data about videos containing this hashtag: likes, users, followers and more. You can enter the hashtags one by one, or use the Bulk edit section to add a prepared list.", "items": { "type": "string" } }, "resultsPerPage": { "title": "๐Ÿ’ฏ Number of videos per hashtag, profile, search, or related", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Add the number of tiktoks you want to scrape per hashtag or profile. Also used as: max video results per keyword search and max related videos per input video URL.", "default": 50 }, "profiles": { "title": "๐Ÿ˜Ž Profiles", "type": "array", "description": "Alternatively, add one or multiple TikTok usernames whose videos and profile data you want to scrape. Don't forget to fill out the ๐Ÿ’ฏ Number of videos you want to scrape in the section above.", "items": { "type": "string" } }, "profileScrapeSections": { "title": "Profile sections to scrape", "type": "array", "description": "If a profile has reposted videos, you can scrape them by selecting 'Reposts'", "items": { "type": "string", "enum": [ "videos", "reposts" ] }, "default": [ "videos" ] }, "profileSorting": { "title": "Profile video sorting", "enum": [ "latest", "popular", "oldest" ], "type": "string", "description": "Select Latest to scrape the most recent videos first, Oldest - the oldest videos first, Popular - the most popular videos first. Date filters only work with Latest and Oldest. Only supported for Videos section", "default": "latest" }, "oldestPostDateUnified": { "title": "Scrape profile videos published after [date]", "type": "string", "description": "Use Absolute tab for specific dates (YYYY-MM-DD) or Relative tab for days ago (e.g., 7 for last 7 days)" }, "newestPostDate": { "title": "Scrape videos published before [date]", "type": "string", "description": "Use Absolute tab for specific dates (YYYY-MM-DD) or Relative tab for days ago (e.g., 0 for today)" }, "excludePinnedPosts": { "title": "Exclude pinned posts", "type": "boolean", "description": "Tick to exclude pinned posts from profiles. Pinned posts are usually the first videos on a profile's page.", "default": false }, "postURLs": { "title": "๐Ÿ”— Video URLs", "type": "array", "description": "Add the URLs of tiktok videos you want to scrape. You can paste video URLs one by one, or use the Bulk edit section to add a prepared list.", "items": { "type": "string" } }, "scrapeRelatedVideos": { "title": "Include related videos for each URL", "type": "boolean", "description": "If enabled, for every provided video URL the actor will also collect 'related' videos visible on the page (up to the Number of videos setting).", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Choose which proxies to use. By default, no proxy is used. If TikTok rejects or blocks the request, the actor will automatically fallback to datacenter proxy, then residential proxy if needed." } } }, "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 } } } } } } } } } }