{ "openapi": "3.0.1", "info": { "title": "TikTok Scraper - from $0.05 per 1,000 videos", "description": "From $0.05 per 1,000 videos. Track public TikTok profiles and hashtags day by day: views, likes, comments, shares and saves for every video, plus comment text and replies.", "version": "0.1", "x-build-id": "ORPzPabZov1LMvJuZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/esdrasdw~tiktok-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-esdrasdw-tiktok-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/esdrasdw~tiktok-scraper/runs": { "post": { "operationId": "runs-sync-esdrasdw-tiktok-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/esdrasdw~tiktok-scraper/run-sync": { "post": { "operationId": "run-sync-esdrasdw-tiktok-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": "👤 TikTok profiles", "type": "array", "description": "Public TikTok profiles, one per line: a handle (nasa), @handle or a profile URL (https://www.tiktok.com/@nasa). Up to 1,000 per run.", "items": { "type": "string" } }, "resultsPerPage": { "title": "🔢 Videos per profile", "minimum": 10, "maximum": 10000, "type": "integer", "description": "How many videos to return for each profile: at least 10, up to 10,000 (and, if you also pick reposts, the maximum number of reposts). A profile with fewer videos returns all it has." }, "profileSorting": { "title": "↕️ Sort videos by", "enum": [ "latest", "oldest" ], "type": "string", "description": "Latest: newest first. Oldest: oldest first, from the very first video. Pinned videos never jump to the top: each one shows up at its own publish date, like any other video.", "default": "latest" }, "profileScrapeSections": { "title": "📂 Profile sections", "type": "array", "description": "Videos: the profile's own videos. Reposts: videos from other accounts that the profile reposted (each one keeps its original author in authorMeta).", "items": { "type": "string", "enum": [ "videos", "reposts" ], "enumTitles": [ "🎬 Videos", "🔁 Reposts" ] }, "default": [ "videos" ] }, "hashtags": { "title": "#️⃣ Hashtags", "type": "array", "description": "Hashtags, one per line: fyp, #fyp or https://www.tiktok.com/tag/fyp. Up to 100 per run.", "items": { "type": "string" } }, "resultsPerHashtag": { "title": "🔢 Videos per hashtag", "minimum": 10, "maximum": 10000, "type": "integer", "description": "How many videos to return for each hashtag, newest first: at least 10, up to 10,000." }, "commentsPerPost": { "title": "💬 Comments per video", "minimum": 0, "maximum": 1000, "type": "integer", "description": "How many comments to include with each video (0 = none).", "default": 0 }, "maxRepliesPerComment": { "title": "↪️ Replies per comment", "minimum": 0, "maximum": 1000, "type": "integer", "description": "How many replies to include under each comment (0 = none). The same as clicking \"View replies\" on TikTok. Only used when comments are on.", "default": 0 }, "oldestPostDateUnified": { "title": "📅 Only videos newer than", "pattern": "^\\s*$|^\\s*\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?\\s*$|^\\s*\\d+\\s*(minute|hour|day|week|month|year)s?(\\s+ago)?\\s*$", "type": "string", "description": "Only videos published on or after this date: YYYY-MM-DD, an ISO timestamp, or a relative period such as 7 days, 2 weeks or 3 months." }, "newestPostDate": { "title": "📅 Only videos older than", "pattern": "^\\s*$|^\\s*\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?\\s*$|^\\s*\\d+\\s*(minute|hour|day|week|month|year)s?(\\s+ago)?\\s*$", "type": "string", "description": "Only videos published before this date. The run jumps straight to it, so an old period of a large profile is fast." }, "selectedFields": { "title": "🧩 Fields to return", "type": "array", "description": "Keep the ones you need and remove the rest; leave it empty to get every field. Comments are always included when you ask for them above.", "items": { "type": "string", "enum": [ "id", "webVideoUrl", "text", "textLanguage", "createTime", "createTimeISO", "playCount", "diggCount", "commentCount", "shareCount", "collectCount", "repostCount", "hashtags", "mentions", "detailedMentions", "isAd", "isSlideshow", "slideshowImageLinks", "location", "effectStickers", "authorMeta", "musicMeta", "videoMeta", "input", "fromProfileSection", "searchHashtag" ], "enumTitles": [ "🆔 Video ID", "🔗 Video link", "📝 Caption", "🌐 Caption language", "⏱️ Publish time (Unix)", "📅 Publish date", "👁️ Views", "❤️ Likes", "💬 Comments", "📤 Shares", "🔖 Saves", "🔁 Reposts", "#️⃣ Hashtags", "@ Mentions", "@ Mentions with ID and link", "📢 Paid ad", "🖼️ Is a slideshow", "🖼️ Slideshow photos", "📍 Location", "✨ Effects", "👤 Profile info (followers, bio, avatar...)", "🎵 Sound (name, author, cover...)", "🎞️ Video file (duration, size, quality, cover...)", "📥 Profile you asked for", "📂 Section (videos or reposts)", "#️⃣ Hashtag you asked for" ] } } } }, "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 } } } } } } } } } }