{ "openapi": "3.0.1", "info": { "title": "TikTok Keyword Scraper", "description": "Scrapes TikTok video search results by keyword using Playwright, with persistent browser profiles, CAPTCHA solving, and an optional Apify residential proxy that can be fully disabled to run direct (no proxy).", "version": "1.0", "x-build-id": "piyZT4sWoIbyfLGjv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devine_device~tiktok-keyword-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devine_device-tiktok-keyword-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/devine_device~tiktok-keyword-scraper/runs": { "post": { "operationId": "runs-sync-devine_device-tiktok-keyword-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/devine_device~tiktok-keyword-scraper/run-sync": { "post": { "operationId": "run-sync-devine_device-tiktok-keyword-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": [ "keywords" ], "properties": { "keywords": { "title": "Search keywords", "type": "array", "description": "One or more keywords/phrases to search on TikTok. Each one runs as its own job.", "items": { "type": "string" } }, "maxResults": { "title": "Max videos per keyword", "minimum": 1, "maximum": 500, "type": "integer", "description": "Stop scrolling once this many videos have been collected for a keyword.", "default": 50 }, "maxConcurrency": { "title": "Max concurrent browsers", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many keywords to scrape in parallel in this run. Each one claims its own persistent browser-profile slot (profile pool size is 10, so keep this at or below 10).", "default": 3 }, "dateFilter": { "title": "Posted within", "enum": [ "0", "1", "7", "30", "90", "180" ], "type": "string", "description": "TikTok's \"Posted\" search filter.", "default": "0" }, "scrollPause": { "title": "Scroll pause (seconds)", "minimum": 1, "maximum": 10, "type": "number", "description": "Delay between scroll actions. Lower is faster but more likely to trigger anti-bot detection.", "default": 3 }, "headless": { "title": "Run headless", "type": "boolean", "description": "Keep this ON for Apify cloud runs — there is no display in the container. Turn it OFF only when running locally for visual debugging.", "default": true }, "useProxy": { "title": "Use proxy", "type": "boolean", "description": "When ON, every browser session routes through the Apify residential proxy pool. Turn this OFF to run with NO proxy at all — every session connects directly. Useful for local testing, debugging, or if your Apify plan has no proxy quota left.", "default": true }, "proxyCountry": { "title": "Proxy exit country (optional)", "type": "string", "description": "2-letter country code to pin the residential proxy's exit IP (e.g. \"EG\" for Egypt). Matching the proxy's country to the search keyword's language/region significantly improves TikTok search result relevance. Leave blank for auto/any country. Ignored when \"Use proxy\" is OFF." }, "proxyPassword": { "title": "Apify proxy password (optional override)", "type": "string", "description": "Override the Actor's built-in Apify residential-proxy password with your own. Leave blank to use the default baked into the Actor. Ignored entirely when \"Use proxy\" is OFF." } } }, "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 } } } } } } } } } }