{ "openapi": "3.0.1", "info": { "title": "TikTok Search by Keywords", "description": "Find relevant public TikTok posts by topic or collect specific video URLs. Export captions, hashtags, creator details and available engagement to CSV, Excel or JSON. No login or cookies needed.", "version": "1.1", "x-build-id": "RL0zAC0ZSmjA02NCD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lofomachines~tiktok-search-by-keywords/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lofomachines-tiktok-search-by-keywords", "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/lofomachines~tiktok-search-by-keywords/runs": { "post": { "operationId": "runs-sync-lofomachines-tiktok-search-by-keywords", "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/lofomachines~tiktok-search-by-keywords/run-sync": { "post": { "operationId": "run-sync-lofomachines-tiktok-search-by-keywords", "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": { "keywords": { "title": "Keywords", "uniqueItems": true, "type": "array", "description": "Topics, hashtags or brand names to research. Add one per line. Only posts judged relevant from their caption, hashtags and available sticker text are saved. Optional when using direct video URLs.", "items": { "type": "string" } }, "videoUrls": { "title": "Video URLs (direct mode)", "uniqueItems": true, "type": "array", "description": "Optional: collect specific public posts from full TikTok video or photo URLs. These are fetched without topic or date filtering; relevance fields are null. Shortened links are not supported. Can be combined with keyword searches.", "items": { "type": "string" } }, "maxVideosPerKeyword": { "title": "Max videos per keyword", "minimum": 1, "maximum": 3000, "type": "integer", "description": "Maximum results for each topic, from 1 to 3,000. Default 100. Availability determines the final count. Direct URLs are handled separately. Free Apify plans stop at 10 total results.", "default": 100 }, "country": { "title": "Target country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter country code of the market you want to target, e.g. \"us\" (United States), \"it\" (Italy), \"gb\" (United Kingdom), \"de\" (Germany), \"fr\" (France), \"es\" (Spain), \"br\" (Brazil), \"in\" (India). Results and language are tuned to this market. Only used for keyword search — direct video URLs ignore it.", "default": "us" }, "publishedAfter": { "title": "Posted after (optional)", "type": "string", "description": "Include posts published on or after this date (UTC). Optional; applies only to keyword search. Results are not guaranteed to be sorted by date." }, "publishedBefore": { "title": "Posted before (optional)", "type": "string", "description": "Include posts published on or before this date (UTC). Optional; applies only to keyword search. Results are not guaranteed to be sorted by date." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }