{ "openapi": "3.0.1", "info": { "title": "TikTok Scraper - Videos, Profiles and Hashtags", "description": "Scrape TikTok videos and profiles by handle, hashtag, keyword or link. Video rows carry plays, likes, comments, shares, saves, caption, sound and author. A profile gives its own row plus its 10 or so newest videos; hashtags and search go deeper. $0.25 per 1,000 rows.", "version": "0.1", "x-build-id": "t9Fzs9CMpaOv3T4TZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dami_studio~tiktok-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dami_studio-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/dami_studio~tiktok-scraper/runs": { "post": { "operationId": "runs-sync-dami_studio-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/dami_studio~tiktok-scraper/run-sync": { "post": { "operationId": "run-sync-dami_studio-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": "Profiles", "type": "array", "description": "TikTok usernames (with or without @) to scrape. Each one returns a profile row (followers, likes, bio, verified) plus that creator's ~10 newest videos, that is all TikTok publishes for a creator without a login.", "items": { "type": "string" } }, "hashtags": { "title": "Hashtags", "type": "array", "description": "Hashtags (with or without #) to scrape videos from.", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Keywords to search TikTok for.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Paste TikTok URLs directly, a profile URL, a /video/ URL (single video), or a /tag/ URL (hashtag).", "items": { "type": "string" } }, "resultsPerPage": { "title": "Max results per run", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Most rows the whole run returns, counted across all your profiles, hashtags, searches and links together, so the first input can use it up. You are charged per result returned. A single profile gives about 11 rows (1 profile + ~10 videos) however high this is set; hashtag and search page much deeper. Not used when Results per input is set.", "default": 50 }, "resultsPerInput": { "title": "Results per input", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Optional. When set, each profile, hashtag, search and video link stops at this many rows, so every input gets its share, and Max results per run is not used. A run can then return up to this many rows for each input you list. Leave it empty to keep one limit for the whole run." }, "maxRunSeconds": { "title": "Max run seconds (cost guard)", "minimum": 10, "maximum": 300, "type": "integer", "description": "Safety cap on total scrape time. If a slow query (e.g. a search/feed that keeps paginating with few results) hits this, the run stops and returns what it has so far. Prevents runaway cost on pathological queries.", "default": 90 }, "minLikes": { "title": "Minimum likes (optional add-on)", "minimum": 0, "type": "integer", "description": "Optional add-on, off unless you set a value. Keeps only videos with at least this many likes. A video whose like count could not be read is left out. Leave it empty to keep every video." }, "maxLikes": { "title": "Maximum likes (optional add-on)", "minimum": 0, "type": "integer", "description": "Optional add-on, off unless you set a value. Keeps only videos with at most this many likes. Leave it empty to keep every video." }, "postedAfter": { "title": "Posted on or after (optional add-on)", "type": "string", "description": "Optional add-on, off unless you set a date. Keeps only videos posted on or after this day, counted in UTC, for example 2026-10-01. Hashtag and search feeds are not sorted by date, so older videos still turn up and are left out. Leave it empty for no date limit." }, "postedBefore": { "title": "Posted before (optional add-on)", "type": "string", "description": "Optional add-on, off unless you set a date. Keeps only videos posted before this day, counted in UTC: 2026-10-15 keeps videos up to the end of 14 October. Leave it empty for no date limit." }, "excludePinned": { "title": "Leave out pinned videos (paid option)", "type": "boolean", "description": "Profiles only. Leaves out the videos a creator pinned to the top of their profile, so you get just their newest ones. Each video it leaves out is billed as \"Pinned video left out\", see the Pricing tab. TikTok marks nothing as pinned, so they are read from the order of the profile's list, and a pinned video that is also the creator's newest stays in.", "default": false }, "includeSubtitles": { "title": "Add TikTok's subtitles", "type": "boolean", "description": "Adds the subtitles TikTok itself publishes for each video, as plain text, with their language. Empty when TikTok has none for that video. Nothing is generated: no transcript is made from the audio. Hashtag and search videos need one more page read each, so those runs take longer.", "default": false }, "notionConnector": { "title": "Notion connector ID (optional)", "type": "string", "description": "Optional. Deliver the results to your connected Notion via Apify MCP connectors." }, "notionParentId": { "title": "Notion data-source ID (optional)", "type": "string", "description": "Optional Notion database/data-source id to create the pages in." }, "sessionCookies": { "title": "Account cookies (not needed)", "minItems": 0, "maxItems": 10, "type": "array", "description": "Optional: your own session, used only for your run. You are responsible for using it within the site's terms. Runs work without it.", "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy (optional)", "type": "object", "description": "Optional, and not needed for a normal run.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }