{ "openapi": "3.0.1", "info": { "title": "TikTok Profile Scraper + Contacts & Analytics", "description": "Scrape TikTok profiles at scale — bio, stats, full video catalog with views/likes/comments, bio contacts (emails,\n phones, Instagram, YouTube, Telegram), engagement analytics and sponsored post detection. Unlimited videos per\n creator. First 10 videos free. No browser needed.", "version": "0.1", "x-build-id": "1Pucob14ijvueQkSC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pro100chok~tiktok-profile-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pro100chok-tiktok-profile-pro", "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/pro100chok~tiktok-profile-pro/runs": { "post": { "operationId": "runs-sync-pro100chok-tiktok-profile-pro", "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/pro100chok~tiktok-profile-pro/run-sync": { "post": { "operationId": "run-sync-pro100chok-tiktok-profile-pro", "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": [ "profiles" ], "properties": { "profiles": { "title": "TikTok profiles", "minItems": 10, "uniqueItems": true, "type": "array", "description": "List of TikTok usernames (with or without @) or full profile URLs, e.g. 'nike', '@nike', 'https://www.tiktok.com/@nike'. Minimum 10 profiles per run.", "items": { "type": "string" } }, "maxVideosPerProfile": { "title": "Max videos per profile", "minimum": 0, "maximum": 2000, "type": "integer", "description": "User's own videos. Fetched via playlists + embed fallback. 0 to disable.", "default": 30 }, "includeReposts": { "title": "Include reposts", "type": "boolean", "description": "Scrape the user's Reposts tab into a separate `reposts` array.", "default": false }, "maxRepostsPerProfile": { "title": "Max reposts per profile", "minimum": 0, "maximum": 2000, "type": "integer", "description": "Only used when Include reposts is on.", "default": 30 }, "includeLikedVideos": { "title": "Include liked videos", "type": "boolean", "description": "Scrape the user's Liked tab into a separate `likedVideos` array. Only works if the user made their likes public (openFavorite=true).", "default": false }, "maxLikedVideosPerProfile": { "title": "Max liked videos per profile", "minimum": 0, "maximum": 2000, "type": "integer", "description": "Only used when Include liked videos is on.", "default": 30 }, "extractContacts": { "title": "Extract contacts from bio", "type": "boolean", "description": "Parse bio + bio-link for emails, phones, Instagram / YouTube / Twitter / Telegram / WhatsApp handles and websites.", "default": true }, "computeAnalytics": { "title": "Compute engagement analytics", "type": "boolean", "description": "Avg/median views, engagement rate, posting frequency, top hashtags/sounds, sponsored-post detection.", "default": true }, "detectSponsored": { "title": "Detect sponsored posts", "type": "boolean", "description": "Flag videos with #ad, #sponsored, #partner, #paidpartnership and similar markers.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel profiles fetched at once.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential US proxy strongly recommended. TikTok serves fewer block pages to US IPs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }