{ "openapi": "3.0.1", "info": { "title": "Best Tiktok Scraper", "description": "Scrape TikTok data from profiles, videos, hashtags, search results, and the trending feed using URLs or keywords. Access video transcripts, view counts, likes, comments, music info, and more. Export data, run scrapes via API, schedule and monitor runs, or integrate with your existing tools.", "version": "0.0", "x-build-id": "lGyb9hThIrjY5efeg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrape-creators~best-tiktok-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrape-creators-best-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/scrape-creators~best-tiktok-scraper/runs": { "post": { "operationId": "runs-sync-scrape-creators-best-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/scrape-creators~best-tiktok-scraper/run-sync": { "post": { "operationId": "run-sync-scrape-creators-best-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": { "hashtags": { "title": "#️⃣ Videos with this hashtag", "type": "array", "description": "List of hashtags to scrape", "items": { "type": "string" } }, "maxItems": { "title": "Max number of videos per hashtag, profile or search", "minimum": 1, "type": "integer", "description": "Maximum number of videos to scrape per hashtag/profile/search. Can't guarantee you'll get this exact amount.", "default": 10 }, "region": { "title": "Region", "type": "string", "description": "Region you want the proxy in. Default is US, but sometimes if you video isn't being returned, you'll need to select the region the video is in. Most likely if the video is in the Philippines, you'll need to select PH.", "default": "US" }, "getTranscripts": { "title": "Get transcripts", "type": "boolean", "description": "Get transcripts for the videos", "default": false }, "usernames": { "title": "Usernames", "type": "array", "description": "TikTok usernames to scrape", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "array", "description": "List of keywords to search for videos", "items": { "type": "string" } }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "most-liked", "date-posted" ], "type": "string", "description": "Sort by relevance or upload date" }, "datePosted": { "title": "Date posted", "enum": [ "yesterday", "this-week", "this-month", "last-3-months", "last-6-months", "last-year", "all-time" ], "type": "string", "description": "Date posted" }, "postURLs": { "title": "Post URLs", "type": "array", "description": "Direct URLs for scraping specific TikToks", "items": { "type": "string" } }, "scrapeTrending": { "title": "Scrape Trending Feed", "type": "boolean", "description": "Scrape videos from the trending feed. Unfortunately you can't specify a search query. You just get what TikTok returns. And you can only get 8 tiktoks at a time, so it takes quite a while :(", "default": false } } }, "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 } } } } } } } } } }