{ "openapi": "3.0.1", "info": { "title": "TikTok Profile & Video Scraper", "description": "Scrape public TikTok profiles and video URLs for video statistics, author details, music and available media metadata. Export data for research and reporting.", "version": "1.0", "x-build-id": "J7JunM81KkRtl30w6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arabiainsights~tiktok-profile-video-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arabiainsights-tiktok-profile-video-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/arabiainsights~tiktok-profile-video-scraper/runs": { "post": { "operationId": "runs-sync-arabiainsights-tiktok-profile-video-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/arabiainsights~tiktok-profile-video-scraper/run-sync": { "post": { "operationId": "run-sync-arabiainsights-tiktok-profile-video-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": "Profiles", "maxItems": 100, "type": "array", "description": "One to 100 TikTok usernames, @usernames, or supported public profile URLs. Provide this or 'Videos' (at least one is required).", "items": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "videos": { "title": "Videos", "maxItems": 1000, "type": "array", "description": "Up to 1,000 TikTok video URLs (canonical https://www.tiktok.com/@username/video/123, mobile share links https://vt.tiktok.com/..., https://vm.tiktok.com/..., or @username/video/123). Mixes freely with 'Profiles'; duplicates are skipped.", "items": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "maxVideosPerProfile": { "title": "Maximum videos per profile", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum accepted Dataset items for each unique profile after filtering and deduplication.", "default": 100 }, "excludePinnedPosts": { "title": "Exclude pinned posts", "type": "boolean", "description": "Skip a profile's pinned posts. Applies to profile listings only; explicitly requested video URLs are always returned.", "default": false }, "profileSorting": { "title": "Profile sorting", "enum": [ "latest", "oldest" ], "type": "string", "description": "Latest returns TikTok's listing order, where pinned posts can appear first. Oldest scans the available listing and returns the oldest found posts first. Oldest can take longer and cost more even with a small result limit; unavailable posts may leave gaps.", "default": "latest" }, "fromDate": { "title": "From date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Inclusive UTC lower date bound." }, "toDate": { "title": "To date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Inclusive UTC upper date bound." }, "proxyCountry": { "title": "Residential proxy country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "ISO 3166-1 alpha-2 country for the residential proxy exit. TikTok serves some content only in certain countries: if a profile fails with CONTENT_WITHHELD, re-run with the country where that content is available.", "default": "US" }, "locale": { "title": "Locale", "minLength": 2, "maxLength": 100, "type": "string", "description": "Preferred language and regional formatting, such as en-US.", "default": "en-US" }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum simultaneous public profile tasks.", "default": 2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Residential Proxy is required. Custom proxies and other proxy groups are not supported. Any country selected here must match Residential proxy country above.", "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 }, "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 } } } } } } } } } }