{ "openapi": "3.0.1", "info": { "title": "TikTok Posts Scraper", "description": "Scrape TikTok posts, video metadata, and engagement data from profiles, hashtags, or keyword searches. Fast bulk extraction with sorting, date filters, and region targeting. Export to JSON, CSV, or Excel.", "version": "0.1", "x-build-id": "aBhua05cdmsaeYwwS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeforge~tiktok-posts/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeforge-tiktok-posts", "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/scrapeforge~tiktok-posts/runs": { "post": { "operationId": "runs-sync-scrapeforge-tiktok-posts", "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/scrapeforge~tiktok-posts/run-sync": { "post": { "operationId": "run-sync-scrapeforge-tiktok-posts", "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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Paste TikTok URLs and get results immediately. Video, User, Search, Tag, and Music URLs are supported. When provided, Scrape Mode is ignored. Free Apify plans are limited to 1 URL per run.", "items": { "type": "string" } }, "scrapeMode": { "title": "Scrape Mode", "enum": [ "profiles", "hashtag", "keyword" ], "type": "string", "description": "Choose what type of TikTok data to scrape.", "default": "profiles" }, "profiles": { "title": "TikTok Profiles", "type": "array", "description": "List of TikTok usernames to scrape (without @). Required when Scrape Mode is 'profiles'. Free Apify plans are limited to 1 profile per run.", "items": { "type": "string" } }, "hashtag": { "title": "Hashtag", "type": "string", "description": "Hashtag to search for (without #). Required when Scrape Mode is 'hashtag'." }, "keyword": { "title": "Search Keyword", "type": "string", "description": "Keyword or phrase to search. Required when Scrape Mode is 'keyword'." }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum total number of posts to return (for hashtag and keyword modes). Free Apify plans are capped at 50.", "default": 50 }, "maxResultsPerProfile": { "title": "Max Results Per Profile", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of posts per profile (for profiles mode). Free Apify plans are capped at 50.", "default": 30 }, "sortBy": { "title": "Sort By", "enum": [ "latest", "popular", "relevance", "most-liked", "date-posted" ], "type": "string", "description": "Sort order. For profiles: 'latest' or 'popular'. For keyword search: 'relevance', 'most-liked', or 'date-posted'." }, "datePosted": { "title": "Date Posted Filter", "enum": [ "yesterday", "this-week", "this-month", "last-3-months", "last-6-months", "all-time" ], "type": "string", "description": "Filter by date (keyword search mode only)." }, "region": { "title": "Region", "type": "string", "description": "2-letter country code for proxy region (e.g., US, GB, FR). Affects which content is returned." } } }, "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 } } } } } } } } } }