{ "openapi": "3.0.1", "info": { "title": "Tiktok Scraper", "description": null, "version": "0.0", "x-build-id": "uWSlC9K4FJEDKQY2X" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sovanza.inc~tiktok-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sovanza.inc-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/sovanza.inc~tiktok-scraper/runs": { "post": { "operationId": "runs-sync-sovanza.inc-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/sovanza.inc~tiktok-scraper/run-sync": { "post": { "operationId": "run-sync-sovanza.inc-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": { "hashtags": { "title": "Hashtags", "type": "array", "description": "Hashtags without # — each opens https://www.tiktok.com/tag/...", "items": { "type": "string" } }, "profiles": { "title": "Profiles", "type": "array", "description": "TikTok usernames (with or without @) or profile URLs", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Keyword search on TikTok web search", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "TikTok video, profile, tag, or search URLs (Apify request list shapes supported)", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "urls": { "title": "URLs (alias)", "type": "array", "description": "Same as startUrls", "items": { "type": "string" } }, "videoUrls": { "title": "Video URLs only", "type": "array", "description": "Direct /@user/video/id links to scrape without listing discovery", "items": { "type": "string" } }, "resultsPerPage": { "title": "Results per seed", "minimum": 1, "maximum": 200, "type": "integer", "description": "Max video links to collect per hashtag/profile/search seed. Prefilled runs use 3 for Apify health checks (under 5 min).", "default": 20 }, "maxItems": { "title": "Max videos to scrape", "minimum": 1, "maximum": 500, "type": "integer", "description": "Cap on unique videos to open and extract (after discovery). Prefilled runs use 2 for Apify health checks.", "default": 30 }, "scrollRoundsPerSeed": { "title": "Scroll rounds per listing seed", "minimum": 1, "maximum": 40, "type": "integer", "description": "Scroll passes on each tag/profile/search page. Use 3–4 for health checks; increase for production.", "default": 12 }, "useOfficialApifyActor": { "title": "Use official Apify TikTok Scraper", "type": "boolean", "description": "If true, runs clockworks/tiktok-scraper via API (requires a plan that supports public Actors). Ignored when session cookies are provided — use Playwright with cookies instead. Default is Playwright only. Fallback: Playwright when token missing, call fails, or dataset is empty.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy; residential is strongly recommended for TikTok on Apify cloud.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "disableProxy": { "title": "Disable proxy", "type": "boolean", "description": "If true, do not use Apify Proxy (local debugging only)", "default": false }, "cookiesJson": { "title": "Cookies JSON (optional)", "type": "string", "description": "Optional Playwright cookie array JSON for .tiktok.com (e.g. sessionid, tt_chain_token). Stored as a secret input and never written to the dataset." }, "cookiesFile": { "title": "Cookies file / KV key (optional)", "type": "string", "description": "Optional cookies source: local file path inside the actor OR an Apify key-value store key whose value is cookies JSON. Stored as a secret input." }, "cookies": { "title": "TikTok cookies (optional, legacy)", "type": "array", "description": "Legacy Playwright cookie array. Prefer cookiesJson in the Apify console. Export from your browser for .tiktok.com." }, "storageState": { "title": "Playwright storage state (optional)", "type": "object", "description": "Full Playwright storageState JSON (cookies + localStorage). Export via page.context.storage_state(). If set, overrides the cookies array." } } }, "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 } } } } } } } } } }