{ "openapi": "3.0.1", "info": { "title": "TikTok Scraper | All-In-One", "description": "Extract TikTok videos, profiles, comments, hashtags, sounds, and follower lists in one Actor. Add a username, video URL, hashtag, or search term and get video IDs, captions, play, like, comment and share counts, plus author and music data. No login required.", "version": "0.1", "x-build-id": "8UrJNY9O7Ck96kqg7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/toolzerhub~tiktok-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-toolzerhub-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/toolzerhub~tiktok-scraper/runs": { "post": { "operationId": "runs-sync-toolzerhub-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/toolzerhub~tiktok-scraper/run-sync": { "post": { "operationId": "run-sync-toolzerhub-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", "required": [ "scraperType" ], "properties": { "scraperType": { "title": "What to collect", "enum": [ "userProfile", "userPosts", "userFollowers", "userFollowing", "video", "videoComments", "videoSearch", "hashtag", "music", "userSearch", "liveRoom" ], "type": "string", "description": "Choose the dataset for this run, then fill in the section for that mode below.", "default": "userProfile" }, "username": { "title": "Username", "type": "string", "description": "TikTok username (without @), or a profile URL (https://www.tiktok.com/@)." }, "sec_user_id": { "title": "Sec User ID (advanced)", "type": "string", "description": "Optional. Leave blank — the secUid is resolved from the Username automatically. Only set this to skip that lookup when you already hold a secUid." }, "addonUserDetails": { "title": "Add User Details", "type": "boolean", "description": "Add country lookup and similar-account recommendations to the profile. One extra request.", "default": false }, "addonProfile": { "title": "Enrich Profiles", "type": "boolean", "description": "Fetch the full public web profile for every result and merge it into the base row. One extra request per result.", "default": false }, "addonSimilarUsers": { "title": "Add Similar Users", "type": "boolean", "description": "Fetch and add TikTok's similar-account recommendations for every result. One extra request per result.", "default": false }, "aweme_id": { "title": "Video ID", "type": "string", "description": "TikTok video (aweme) ID, or a full video URL (https://www.tiktok.com/@/video/)." }, "share_url": { "title": "Share URLs", "type": "array", "description": "TikTok share links to resolve, one per line. Full https://vt.tiktok.com/... and https://vm.tiktok.com/... URLs are accepted.", "items": { "type": "string" } }, "maxRepliesPerComment": { "title": "Max Replies Per Comment", "minimum": 0, "type": "integer", "description": "Maximum replies to save for each top-level comment. Replies also count toward Max Results. Set 0 for no per-comment limit.", "default": 3 }, "addonCommentReplies": { "title": "Add Comment Replies", "type": "boolean", "description": "Paginate replies and save each as a separate comment row. Replies count toward Max Results.", "default": false }, "keyword": { "title": "Search Keyword", "type": "string", "description": "Keyword or phrase to search TikTok for." }, "addonVideoDetails": { "title": "Add Video Details", "type": "boolean", "description": "Merge the full video detail response into every video row. One extra request per item.", "default": false }, "tag_name": { "title": "Hashtag", "type": "string", "description": "TikTok hashtag name without the # symbol." }, "addonHashtagVideos": { "title": "Add Hashtag Videos", "type": "boolean", "description": "Return each current top video as a separate row with hashtag context. One extra request.", "default": false }, "music_id": { "title": "Sound", "type": "string", "description": "A TikTok sound/music ID, or a full sound URL (https://www.tiktok.com/music/-)." }, "addonMusicVideos": { "title": "Add Music Videos", "type": "boolean", "description": "Return each video using this sound as a separate row with music context. One extra request.", "default": false }, "room_id": { "title": "Live Room ID (advanced)", "type": "string", "description": "Optional. A TikTok LIVE room ID, if you already have one. Leave blank and give a Username instead — a room ID appears in no public TikTok URL, so there is normally no way to obtain one by hand." }, "maxItems": { "title": "Max Results", "minimum": 0, "type": "integer", "description": "Maximum number of items to save. Set 0 for no limit.", "default": 100 }, "region": { "title": "Region", "type": "string", "description": "Two-letter region code affecting search/feed results, e.g. US, GB, JP.", "default": "US" } } }, "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 } } } } } } } } } }