{ "openapi": "3.0.1", "info": { "title": "TikTok Creator & Profile Scraper", "description": "Scrape TikTok creator profiles in bulk: exact follower, like and video counts, verified and business-account flags, TikTok Shop seller status, category, bio link and the contact e-mails creators publish in their bios. Video URLs resolve too. From $10 / 1,000 creators.", "version": "0.0", "x-build-id": "aORGLV7ZHQ3m8eO43" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/eiv~tiktok-creator-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-eiv-tiktok-creator-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/eiv~tiktok-creator-scraper/runs": { "post": { "operationId": "runs-sync-eiv-tiktok-creator-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/eiv~tiktok-creator-scraper/run-sync": { "post": { "operationId": "run-sync-eiv-tiktok-creator-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": { "profiles": { "title": "Creators or videos", "type": "array", "description": "TikTok handles ('@gymshark' or 'gymshark'), profile URLs, or video URLs — one per line. Video URLs are resolved through TikTok's public oEmbed endpoint and billed at the cheaper video rate.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (for chaining)", "type": "array", "description": "Alternative to Creators, for feeding the output of another Actor straight into this one.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "sourceDatasetId": { "title": "Source dataset ID", "type": "string", "description": "Read handles from an existing dataset instead of a pasted list." }, "sourceDatasetField": { "title": "Source dataset field", "type": "string", "description": "Which field on the source dataset holds the handle or profile URL.", "default": "handle" }, "minFollowers": { "title": "Minimum followers", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Drop creators below this follower count. Filtered creators are not written to the dataset and are not charged, so this is the cheapest way to screen a large list. Leave at 0 to keep everyone.", "default": 0 }, "businessAccountsOnly": { "title": "Business accounts only", "type": "boolean", "description": "Keep only accounts registered as business/commerce accounts. These are the ones with a category and, usually, a contactable brand behind them.", "default": false }, "withContactEmailOnly": { "title": "Only creators with a contact e-mail", "type": "boolean", "description": "Keep only creators whose bio contains a reachable e-mail address. Turns a broad creator list into an outreach list in one pass.", "default": false }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Profiles fetched in parallel. TikTok is more rate-sensitive than an open API, so the default is deliberately modest; raise it gradually and watch for HTTP 403.", "default": 10 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 3, "maximum": 120, "type": "integer", "description": "Per-request timeout.", "default": 30 }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries for connection resets and 5xx responses, on the same IP.", "default": 2 }, "blockedRetries": { "title": "IP rotations when blocked", "minimum": 0, "maximum": 8, "type": "integer", "description": "How many times to retry a profile on a fresh proxy IP after TikTok serves a block page. A residential pool contains both clean and flagged addresses, so rotating is what actually fixes a refusal — and a block page costs about 20 KB against a real profile's 357 KB, making retries cheap. Raise this if you still see NO_STATE_BLOB errors.", "default": 3 }, "flattenOutput": { "title": "Flatten output for CSV", "type": "boolean", "description": "Emit flat dot-notation columns with arrays joined by ' | '. Use for spreadsheets; leave off for warehouses.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Strongly recommended: TikTok blocks datacenter IP ranges aggressively. If you see HTTP 403 or NO_STATE_BLOB errors, enable the Apify proxy with the RESIDENTIAL group. Running without a proxy is cheaper and works from some ranges, so it is worth trying first on a small list.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }