{ "openapi": "3.0.1", "info": { "title": "Tiktok Followers Api Scraper", "version": "0.1", "x-build-id": "opvRIAYSEbcKEAAgX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraperx~tiktok-followers-api-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraperx-tiktok-followers-api-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/scraperx~tiktok-followers-api-scraper/runs": { "post": { "operationId": "runs-sync-scraperx-tiktok-followers-api-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/scraperx~tiktok-followers-api-scraper/run-sync": { "post": { "operationId": "run-sync-scraperx-tiktok-followers-api-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", "required": [ "sid_tt" ], "properties": { "username": { "title": "Username", "type": "string", "description": "Enter the TikTok **username** (handle) of the profile whose followers you want. Do not include @ or the full URL — just the handle, e.g. **nike**, **khaby.lame**, **mrbeast**.", "default": "mrbeast" }, "sid_tt": { "title": "TikTok session cookie (sid_tt)", "type": "string", "description": "**Required.** A valid **sid_tt** cookie from a logged-in TikTok session. TikTok does not return follower lists without an authenticated session. Get the cookie from your browser: open tiktok.com, log in, then DevTools → Application → Cookies → tiktok.com → copy the **sid_tt** value.", "default": "" }, "userUrl": { "title": "User's URL", "type": "string", "description": "Alternatively, paste the **full TikTok profile URL**, e.g. **https://www.tiktok.com/@nickiminai**. The Actor will extract the username and scrape that profile's followers. Use either Username or URL (or both for multiple runs).", "default": "" }, "maxFollowersPerProfile": { "title": "Number of followers", "minimum": 1, "maximum": 5000, "type": "integer", "description": "**Maximum number of followers** to collect per profile (1–5000). This Actor collects followers only; the limit applies to the follower count. The Actor scrolls the followers modal until it reaches this count or no more users load. Higher values take longer.", "default": 100 }, "simplyOutput": { "title": "Simply Output", "type": "boolean", "description": "Turn **on** to get only **authorMeta** per follower (follower profile only). Turn **off** (default) for the full object per follower: authorMeta, connectedTo, connectionType, and connectionDescription.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "**Proxy settings.** By default the Actor uses **no proxy**. If TikTok blocks the request, it automatically falls back to **datacenter** proxy, then **residential** proxy (with retries). Enable Apify Proxy here if you want to start with proxy from the beginning." } } }, "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 } } } } } } } } } }