{ "openapi": "3.0.1", "info": { "title": "TikTok Profile Scraper", "description": "Export public TikTok profiles by handle or URL: followers, likes, bios, links, verification, account settings, commerce and seller signals, profile ratios, live status, and recent videos when TikTok exposes them.", "version": "0.1", "x-build-id": "moIYVdVqN7McexoP5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetch_cat~tiktok-profile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetch_cat-tiktok-profile-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/fetch_cat~tiktok-profile-scraper/runs": { "post": { "operationId": "runs-sync-fetch_cat-tiktok-profile-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/fetch_cat~tiktok-profile-scraper/run-sync": { "post": { "operationId": "run-sync-fetch_cat-tiktok-profile-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": { "handles": { "title": "TikTok handles", "maxItems": 500, "type": "array", "description": "Usernames with or without @, such as tiktok or @tiktok. Supply at least one valid handle here or a profile URL below; either field alone or both together works.", "items": { "type": "string", "maxLength": 2048 } }, "profileUrls": { "title": "TikTok profile URLs", "maxItems": 500, "type": "array", "description": "Public profile URLs, such as https://www.tiktok.com/@tiktok. Supply at least one valid URL here or a handle above; either field alone or both together works.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxProfiles": { "title": "Maximum profiles", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum unique profiles from the combined handles and URLs (1–500). The form defaults to 5; API inputs that omit this setting retain the existing limit of 50.", "default": 5 }, "includeRecentVideos": { "title": "Include recent video summaries", "type": "boolean", "description": "Include recent public posts when available. Reuse profile posts or the public creator list first; try an anonymous browser only if no usable list is available. Two consecutive failures of both routes pause further post lookups, not profile collection. Available counts and details vary; missing details stay empty. No full-history pagination.", "default": true }, "maxVideosPerProfile": { "title": "Maximum recent videos per profile", "minimum": 0, "maximum": 50, "type": "integer", "description": "Maximum recent summaries per profile when available (0–50; default 12). Zero skips recent-post lookup. Only posts exposed by TikTok are returned.", "default": 12 }, "connectionMode": { "title": "Connection", "enum": [ "direct", "automatic" ], "type": "string", "description": "Direct uses no proxy. Automatic uses standard Apify Proxy; it does not switch to residential fallback. Explicit saved/API proxyConfiguration settings take precedence over this form choice." }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Profiles processed in parallel (1–10; default 3). With 1024 MiB and at most three profile workers, up to two optional browser lookups run together. Other allocations or larger worker pools use one browser lookup at a time to bound memory. Lower this if TikTok is rate-limiting your selected connection.", "default": 3 }, "runTimeSecs": { "title": "Processing deadline", "minimum": 30, "maximum": 270, "type": "integer", "description": "Original-run processing deadline, including restarts. Unprocessed targets are reported in RUN_SUMMARY; this limit cannot be renewed by extending the platform timeout.", "default": 180 }, "proxyConfiguration": { "title": "Saved/API proxy configuration", "type": "object", "description": "Existing managed groups/countries, customer proxy pools and explicit opt-outs remain supported and take precedence over Connection. Omitting both settings preserves standard Apify Proxy. Null explicitly selects direct access. Invalid or unavailable selections never enable an alternate paid route." } } }, "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 } } } } } } } } } }