{ "openapi": "3.0.1", "info": { "title": "TikTok Creator Profile Scraper API - Followers, Bio Link", "description": "Turn TikTok handles into creator records: exact follower, like and video counts, bio, the link in the bio, verification, region and account age. Not TikTok's rounded numbers. Failures are free.", "version": "1.0", "x-build-id": "SPhd6ouYHOyy6TlYO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vonsensey~tiktok-creator-profile-scraper-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vonsensey-tiktok-creator-profile-scraper-api", "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/vonsensey~tiktok-creator-profile-scraper-api/runs": { "post": { "operationId": "runs-sync-vonsensey-tiktok-creator-profile-scraper-api", "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/vonsensey~tiktok-creator-profile-scraper-api/run-sync": { "post": { "operationId": "run-sync-vonsensey-tiktok-creator-profile-scraper-api", "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": { "videoUrls": { "title": "TikTok video URLs", "type": "array", "description": "Video links, share links or bare video IDs. Paste them however you have them — the /@user/video/... form, a link with tracking parameters, or just the numeric ID. Deleted, private and region-locked videos return a free error row saying which, and never a charge. Leave empty and give creator handles instead to run profiles only.", "items": { "type": "string" } }, "profiles": { "title": "TikTok creator handles", "type": "array", "description": "Creator handles or profile URLs — 'nasa', '@nasa' and 'https://www.tiktok.com/@nasa' all work. Each one returns a profile row with exact follower, like and video counts, the bio and the link in the bio.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum results", "minimum": 1, "type": "integer", "description": "Hard cap on billable rows for this run. Videos and creator profiles share this budget, so 100 means 100 rows in total, never 100 of each.", "default": 100 }, "maxCostUsd": { "title": "Cost ceiling (USD)", "minimum": 0, "type": "integer", "description": "Stop the run before it spends more than this. Leave empty for no ceiling. The free summary row always reports what the run actually spent." }, "includeCreatorProfiles": { "title": "Add full creator profiles", "type": "boolean", "description": "Every video already includes its creator's handle, verification and follower count at no extra cost. Turn this on to also resolve each distinct creator in full — bio, link in bio, region, account age and lifetime totals. Charged once per creator per run, never per video, and only after the profile has actually been read.", "default": false }, "includeMediaUrls": { "title": "Include video and cover file URLs", "type": "boolean", "description": "Adds the direct play and download URLs to each video row. They are signed by TikTok and expire quickly, so they are left out by default rather than filling a stored dataset with links that stop working.", "default": false }, "monitorChangesOnly": { "title": "Monitor: only bill what changed", "type": "boolean", "description": "For scheduled runs. The Actor remembers the counts it saw last time and bills only the videos and profiles whose numbers actually moved. Unchanged rows are still delivered, marked 'unchanged', and are free.", "default": false }, "useProxy": { "title": "Force proxy", "type": "boolean", "description": "Not normally needed — everything is handled for you and the Actor escalates automatically if TikTok refuses a request. Turn it on only if you have been asked to.", "default": false } } }, "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 } } } } } } } } } }