{ "openapi": "3.0.1", "info": { "title": "TikTok Profile Videos API Scraper", "description": "Collect public TikTok profile videos from usernames, profile URLs, or numeric user IDs. Get one deduplicated row per upload with captions, engagement counts, creator details, sounds, hashtags, media links, and optional playlist or repost context when TikTok shows them.", "version": "0.0", "x-build-id": "iZ2jCxfDByqLvdNo1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~tiktok-profile-videos-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-tiktok-profile-videos-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/maximedupre~tiktok-profile-videos-api/runs": { "post": { "operationId": "runs-sync-maximedupre-tiktok-profile-videos-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/maximedupre~tiktok-profile-videos-api/run-sync": { "post": { "operationId": "run-sync-maximedupre-tiktok-profile-videos-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", "required": [ "creatorTargets" ], "properties": { "creatorTargets": { "title": "Creator profiles", "minItems": 1, "type": "array", "description": "Add one or more public TikTok creator usernames, profile URLs, or numeric user IDs. Use one value per line.", "items": { "type": "string" } }, "includePlaylists": { "title": "Include playlists", "type": "boolean", "description": "Include public uploads found in the target creator's playlists or mixes, with playlist details when available. Playlist name filtering applies only when this is on.", "default": false }, "checkPlaylistMembership": { "title": "Check playlist membership", "type": "boolean", "description": "Check ordinary profile-feed videos for public playlist or mix membership. This adds membership details to those rows and does not collect playlist-only videos.", "default": false }, "playlistNameFilter": { "title": "Playlist name filter", "type": "string", "description": "Only collect public playlists or mixes whose name matches this text. This applies when Include playlists is on. Leave it blank or omit it to include all public playlists and mixes." }, "includeReposts": { "title": "Include reposted videos", "type": "boolean", "description": "Include public videos reposted by the target creator and mark them as reposts. The original video and creator are included when TikTok exposes them.", "default": false }, "onlyAmplified": { "title": "Only reposts or mentions", "type": "boolean", "description": "Keep only uploads that repost or mention another creator. This filter does not turn on repost collection.", "default": false }, "enrichRelatedCreators": { "title": "Enrich related creators", "type": "boolean", "description": "Request extra public profile details for creators found in reposts or caption mentions, including audience size, content counts, bio information, links, and business account status.", "default": false }, "maxItems": { "title": "Maximum uploads per profile", "minimum": 1, "type": "integer", "description": "Enter a positive whole number to stop after this many uploads for each requested profile. Leave it empty to collect all uploads TikTok exposes for the selected surfaces. This limit applies to each profile, not the whole run." }, "sortOrder": { "title": "Result order", "enum": [ "newest", "oldest" ], "type": "string", "description": "Choose the order of uploads within each profile.", "default": "newest" } } }, "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 } } } } } } } } } }