{ "openapi": "3.0.1", "info": { "title": "TikTok Scraper: Videos, Comments, Hashtags & Profiles", "description": "TikTok scraper for videos by profile, keyword search, hashtag or link, plus comments, profile details, followers and following. Exact limits, real date and view filters, no mock data, and you pay only for real, unique rows.", "version": "0.1", "x-build-id": "0boDITh9PchK3cEUm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apisamurai~tiktok-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apisamurai-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/apisamurai~tiktok-scraper/runs": { "post": { "operationId": "runs-sync-apisamurai-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/apisamurai~tiktok-scraper/run-sync": { "post": { "operationId": "run-sync-apisamurai-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": "Get the videos of these accounts, newest first. Usernames or profile links: khaby.lame, @khaby.lame or https://www.tiktok.com/@khaby.lame. One per line.", "items": { "type": "string" } }, "includeProfile": { "title": "Include profile details", "type": "boolean", "description": "On: each profile also gets one user row with bio, followers, following, total likes and video count. Each of these rows is billed as a profile (see Pricing). Free plan: up to 10 per run.", "default": false }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Keyword search for videos, one query per line.", "items": { "type": "string" } }, "hashtags": { "title": "Hashtags", "type": "array", "description": "Videos under these hashtags. With or without #, or a tiktok.com/tag link. One per line.", "items": { "type": "string" } }, "videoUrls": { "title": "Video links", "type": "array", "description": "Fetch full details of these videos or photo posts, e.g. https://www.tiktok.com/@user/video/7463250363559218474. Short vm.tiktok.com links work too. One per line.", "items": { "type": "string" } }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "On: collect the comments of every video saved by this run (one row per comment).", "default": false }, "maxCommentsPerVideo": { "title": "Max comments per video", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum comment rows for each video. Enforced exactly.", "default": 50 }, "followersOf": { "title": "Followers of", "type": "array", "description": "Collect the followers of these accounts (one row per user). Usernames or profile links, one per line.", "items": { "type": "string" } }, "followingOf": { "title": "Following of", "type": "array", "description": "Collect the accounts these accounts follow (one row per user). Usernames or profile links, one per line.", "items": { "type": "string" } }, "maxItemsPerSource": { "title": "Max rows per input item", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum videos (or users) for each profile, search query, hashtag or follower list. Enforced exactly: the last page is trimmed. Comments and profile rows are counted separately.", "default": 50 }, "maxTotalItems": { "title": "Max rows for the whole run", "minimum": 1, "maximum": 10000000, "type": "integer", "description": "Optional hard cap on all rows (videos, comments and users) across all input items. Leave empty for no total cap." }, "postedAfter": { "title": "Posted after", "type": "string", "description": "Only videos posted on or after this day (UTC). Videos outside the range are skipped and not charged." }, "postedBefore": { "title": "Posted before", "type": "string", "description": "Only videos posted on or before this day (UTC, the whole day is included)." }, "minViews": { "title": "Min views", "minimum": 0, "type": "integer", "description": "Skip videos with fewer views." }, "minLikes": { "title": "Min likes", "minimum": 0, "type": "integer", "description": "Skip videos with fewer likes." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }