{ "openapi": "3.0.1", "info": { "title": "TikTok Video Scraper: Related Videos & Hashtag Network", "description": "🎯 TikTok Video Scraper: Related Videos & Hashtag Network pulls public video metadata at scale—captions, hashtags, views, likes, comments, shares, sound, author, publish time & URLs. 📊 Export CSV/JSON for analytics, growth, and competitor research. 🚀 Perfect for marketers, analysts & creators.", "version": "0.2", "x-build-id": "Q1rV6LLszlBm9Evnw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraply~tiktok-video-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraply-tiktok-video-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/scraply~tiktok-video-scraper/runs": { "post": { "operationId": "runs-sync-scraply-tiktok-video-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/scraply~tiktok-video-scraper/run-sync": { "post": { "operationId": "run-sync-scraply-tiktok-video-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": [ "postURLs" ], "properties": { "postURLs": { "title": "Direct URL(s) for scraping specific video(s)", "type": "array", "description": "Add the URLs of posted videos you want to scrape (these become the seed videos for network expansion below). You can enter URLs one by one, or upload/link a text file.", "items": { "type": "string" } }, "scrapeRelatedVideos": { "title": "Legacy: enable basic related-video expansion", "type": "boolean", "description": "Kept for compatibility with the original scraper's input. Turns on one level of related-video expansion when the settings below are left at their defaults. For full depth/breadth control, use \"Related-video graph depth\" and \"Max related videos per level\" instead.", "default": false }, "resultsPerPage": { "title": "Legacy: related videos per post (basic mode)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Kept for compatibility with the original scraper's input. Used only when \"Max related videos per level\" below is left unset.", "default": 10 }, "relatedVideoDepth": { "title": "Related-video graph depth", "minimum": 0, "maximum": 2, "type": "integer", "description": "How many levels deep to recursively expand the related-video graph from each seed video (0 = off, 1 = one hop, 2 = two hops). Each extra level multiplies the number of lookups, so keep this small." }, "maxRelatedPerLevel": { "title": "Max related videos per level", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of related videos to collect for each video at every graph level." }, "expandHashtagNeighborhood": { "title": "Expand hashtag neighborhood", "type": "boolean", "description": "For each seed video, also discover sibling videos published under that video's OWN top hashtag (not a hashtag you supply).", "default": false }, "maxHashtagNeighborsPerSeed": { "title": "Max hashtag-neighbor videos per seed", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of hashtag-neighborhood videos to collect per seed video. Only used when \"Expand hashtag neighborhood\" is enabled." } } }, "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 } } } } } } } } } }