{ "openapi": "3.0.1", "info": { "title": "TikTok Scraper", "description": "Scrape TikTok videos, user profiles, hashtags, and comments. Search by keyword, hashtag, or username. Extracts views, likes, shares, comments, author stats, music, and more.", "version": "0.1", "x-build-id": "rxVp2FRxBhtRnG9am" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rupom888~tiktok-scraper-js/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rupom888-tiktok-scraper-js", "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/rupom888~tiktok-scraper-js/runs": { "post": { "operationId": "runs-sync-rupom888-tiktok-scraper-js", "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/rupom888~tiktok-scraper-js/run-sync": { "post": { "operationId": "run-sync-rupom888-tiktok-scraper-js", "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": [ "scrapeType", "queries" ], "properties": { "scrapeType": { "title": "Scrape Type", "enum": [ "search", "hashtag", "trending", "user", "followers", "following", "comments" ], "type": "string", "description": "What to scrape: keyword search, hashtag videos, trending videos, user profile, followers/following lists, or video comments.", "default": "search" }, "queries": { "title": "Search Keywords / Hashtags / Usernames / Video URLs", "type": "array", "description": "Keywords for search, hashtag names (without #), usernames (without @), or video URLs for comments.", "items": { "type": "string" } }, "resultsPerQuery": { "title": "Results Per Query", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Number of videos/users/comments to extract per keyword/hashtag/user.", "default": 50 }, "profileSorting": { "title": "Profile Sorting", "enum": [ "latest", "popular" ], "type": "string", "description": "Sort order for user profile videos (latest or popular). Only applies to scrapeType=user.", "default": "latest" }, "excludePinnedPosts": { "title": "Exclude Pinned Posts", "type": "boolean", "description": "Skip pinned videos when scraping user profiles.", "default": false }, "includeComments": { "title": "Include Comments", "type": "boolean", "description": "Also fetch top comments for each video (slower, more data).", "default": false }, "commentsPerVideo": { "title": "Comments Per Video", "minimum": 1, "maximum": 500, "type": "integer", "description": "Number of comments to fetch per video (if Include Comments is on).", "default": 20 }, "minViews": { "title": "Minimum Views", "minimum": 0, "type": "integer", "description": "Only return videos with at least this many views. Set 0 to disable.", "default": 0 }, "minLikes": { "title": "Minimum Likes", "minimum": 0, "type": "integer", "description": "Only return videos with at least this many likes. Set 0 to disable.", "default": 0 }, "minComments": { "title": "Minimum Comments", "minimum": 0, "type": "integer", "description": "Only return videos with at least this many comments. Set 0 to disable.", "default": 0 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Residential proxy recommended for best results." } } }, "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 } } } } } } } } } }