{ "openapi": "3.0.1", "info": { "title": "TikTok Scraper With Advanced Filters", "description": "TikTok Scraper With Advanced Filters extracts TikTok videos and profiles using filters like keywords, hashtags, language, region, engagement, date, and more. Get captions, views, likes, comments, shares, creator data, and timestamps for research and analysis.", "version": "0.1", "x-build-id": "nkBPpob3yOF11mp7E" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapier~tiktok-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapier-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/scrapier~tiktok-scraper/runs": { "post": { "operationId": "runs-sync-scrapier-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/scrapier~tiktok-scraper/run-sync": { "post": { "operationId": "run-sync-scrapier-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": { "startUrls": { "title": "๐Ÿ‘ค TikTok Profile URLs or Usernames", "type": "array", "description": "๐Ÿ“‹ Add TikTok profile URLs (e.g., https://www.tiktok.com/@username) or just usernames (e.g., username). Supports bulk input - add as many profiles as you want! ๐Ÿ’ช Leave empty if you only want to do search scraping.", "items": { "type": "string" } }, "profileScrapeSections": { "title": "๐Ÿ“น Profile Scrape Sections", "type": "array", "description": "๐ŸŽฏ Choose which sections to scrape from profiles: ๐Ÿ“บ 'videos' (all profile videos) and/or ๐Ÿ”„ 'repost' (reposted content). Select one or both!", "items": { "type": "string", "enum": [ "videos", "repost" ] }, "default": [ "videos" ] }, "searchQuery": { "title": "๐Ÿ” Search Query", "type": "string", "description": "๐Ÿ”Ž Enter a search query for hashtag or keyword search. Leave empty if you only want to scrape profiles. Examples: 'Ronaldo', '#travel', 'cooking tips'", "default": "" }, "searchType": { "title": "๐Ÿท๏ธ Search Type", "enum": [ "keyword", "hashtag" ], "type": "string", "description": "๐Ÿ“Œ Choose search type: ๐Ÿ”‘ 'keyword' (general TikTok search) or #๏ธโƒฃ 'hashtag' (hashtag-specific search). Default: keyword", "default": "keyword" }, "maxResults": { "title": "๐Ÿ“Š Maximum Results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "๐ŸŽฏ Maximum number of results to collect per profile/search query, BEFORE the filters below are applied. Range: 1-1000. Higher values = more data but longer scraping time. โฑ๏ธ", "default": 100 }, "minEngagement": { "title": "๐Ÿ‘ Minimum Likes", "minimum": 0, "type": "integer", "description": "๐Ÿšฆ Drop any row whose like count is below this number. Example: minEngagement=1000 keeps only videos/reposts with 1,000+ likes. Default is 0 (no filtering).", "default": 0 }, "excludeKeywords": { "title": "๐Ÿšซ Exclude Keywords", "type": "array", "description": "๐Ÿงน Drop any row whose caption/description text contains any of these words or phrases (case-insensitive). Example: [\"giveaway\", \"ad\"] removes captions mentioning either term. Default is empty (no filtering).", "default": [], "items": { "type": "string" } }, "oldestDate": { "title": "๐Ÿ“… Oldest Date", "type": "string", "description": "๐Ÿ—“๏ธ Drop any row posted before this date. Accepts an absolute date (e.g. 2025-01-01) or a relative value (e.g. 30 days). Leave empty for no date filtering.", "default": "" }, "proxyConfiguration": { "title": "๐ŸŒ Proxy Configuration", "type": "object", "description": "๐Ÿ”’ Proxy settings for enhanced reliability. By default, no proxy is used (direct connection)." } } }, "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 } } } } } } } } } }