{ "openapi": "3.0.1", "info": { "title": "Tiktok Search Scraper", "description": "Fast, stealthy TikTok Search Scraper for real-time video data extraction. Get captions, views, music, and author details for any query. Features advanced anti-block technology. Perfectly optimized for marketing research, trend tracking, and influencer analytics on the Apify platform.", "version": "0.0", "x-build-id": "nh2nhlhglafN68Rv1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/eunit~tiktok-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-eunit-tiktok-search-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/eunit~tiktok-search-scraper/runs": { "post": { "operationId": "runs-sync-eunit-tiktok-search-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/eunit~tiktok-search-scraper/run-sync": { "post": { "operationId": "run-sync-eunit-tiktok-search-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": [ "queries" ], "properties": { "queries": { "title": "Search Queries", "type": "array", "description": "List of search queries to scrape.", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Total number of videos to scrape per query.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy configuration for the scraper. TikTok blocks all datacenter IP ranges — residential proxies are strongly recommended for Apify-hosted runs. When left unconfigured, the scraper logs an error and continues without a proxy (results are unlikely on the Apify platform). If you set a Custom Proxy URL below, this field is ignored.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "sessionCookies": { "title": "Session Cookies (bypass datacenter block)", "type": "string", "description": "Paste the JSON cookie array exported from your browser's real TikTok session. This injects your authenticated session (msToken, ttwid, s_v_web_id, etc.) directly into the scraper, bypassing TikTok's cookie-based bot detection even on datacenter IPs.\n\nHow to export:\n1. Install the 'Cookie-Editor' extension for Chrome/Firefox.\n2. Open https://www.tiktok.com and browse normally for 30 seconds.\n3. Click the Cookie-Editor icon → click 'Export' → 'Export as JSON'.\n4. Paste the full JSON array here.\n\nNote: Cookies expire (usually within a few hours to days). Re-export if scraping stops working." }, "customProxyUrl": { "title": "Custom Proxy URL (use your home/local IP)", "type": "string", "description": "Route all actor traffic through your own proxy server so TikTok sees your home IP instead of Apify's datacenter IP. Takes priority over the Proxy Configuration above.\n\nFormat: socks5://user:pass@host:port or http://host:port\n\nHow to set up a free tunnel from your local machine:\n1. Install microsocks (Linux/macOS) or use 'node-socks5-server' (npm).\n2. Start it: microsocks -p 1080 (or the npm equivalent).\n3. Install ngrok (free tier supports TCP tunnels).\n4. Run: ngrok tcp 1080\n5. Paste the ngrok URL here as: socks5://0.tcp.ngrok.io:\n\nYour machine must stay running while the actor is active." } } }, "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 } } } } } } } } } }