{ "openapi": "3.0.1", "info": { "title": "TikTok Scraper: Videos by Keyword, Profile, Hashtag & URL", "description": "Scrape TikTok videos by keyword, profile, hashtag or URL: plays, likes, saves, creator followers, music, country, transcripts. Export CSV, Excel, JSON, XML.", "version": "0.1", "x-build-id": "YF806ZCymMrLIJPuA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~tiktok-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-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/parseforge~tiktok-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-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/parseforge~tiktok-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-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": { "keywords": { "title": "Keywords", "type": "array", "description": "Find videos by keyword, the way TikTok's public keyword pages list them (up to about 100 videos per keyword). Use common phrases; spaces are joined with hyphens for you (\"skincare routine\" becomes \"skincare-routine\").", "items": { "type": "string" } }, "profiles": { "title": "Profiles", "type": "array", "description": "Videos posted by these creators. A username, @username or profile URL, e.g. \"nasa\" or \"https://www.tiktok.com/@nasa\".", "items": { "type": "string" } }, "hashtags": { "title": "Hashtags", "type": "array", "description": "Videos under these hashtags, e.g. \"space\", \"#booktok\" or \"https://www.tiktok.com/tag/booktok\".", "items": { "type": "string" } }, "videoUrls": { "title": "Video URLs", "type": "array", "description": "Full details for specific videos. Video links (https://www.tiktok.com/@user/video/123...), short links (vm.tiktok.com/...) or bare video ids.", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" }, "maxVideosPerSource": { "title": "Max videos per profile, hashtag or keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many videos to take from each profile, hashtag or keyword. TikTok's keyword pages stop at about 100 videos.", "default": 30 }, "region": { "title": "Keyword region", "enum": [ "US", "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "DY", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "VG", "BN", "BG", "BF", "HV", "BI", "KH", "CM", "CA", "CV", "BQ", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "ZR", "CK", "CR", "CI", "HR", "CU", "AN", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "FX", "GF", "PF", "TF", "GA", "GM", "GE", "DD", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "BU", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "KP", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "SU", "RW", "WS", "SM", "ST", "SA", "SN", "CS", "RS", "YU", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "KR", "SS", "ES", "LK", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TP", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UM", "VI", "UG", "UA", "AE", "GB", "UK", "UY", "UZ", "NH", "VU", "VA", "VE", "VD", "VN", "WF", "EH", "YD", "YE", "ZM", "RH", "ZW" ], "type": "string", "description": "The country whose TikTok feed answers keyword searches. It changes which videos come back (measured: Japan and the US share about half of their top 30 for the same keyword). Applies to keywords only.", "default": "US" }, "publishedAfter": { "title": "Published after", "type": "string", "description": "Keep only videos posted on or after this date. YYYY-MM-DD, or a relative span like \"7 days\", \"2 weeks\", \"3 months\". On profiles this also stops the scroll early, so it saves time." }, "publishedBefore": { "title": "Published before", "type": "string", "description": "Keep only videos posted on or before this date (YYYY-MM-DD)." }, "minPlays": { "title": "Minimum plays", "minimum": 0, "type": "integer", "description": "Keep only videos with at least this many plays." }, "minLikes": { "title": "Minimum likes", "minimum": 0, "type": "integer", "description": "Keep only videos with at least this many likes." }, "minComments": { "title": "Minimum comments", "minimum": 0, "type": "integer", "description": "Keep only videos with at least this many comments." }, "excludePinned": { "title": "Skip pinned videos", "type": "boolean", "description": "Profiles only: leave out the videos a creator pinned to the top of the profile.", "default": false }, "excludeAds": { "title": "Skip ads", "type": "boolean", "description": "Leave out videos TikTok marks as ads.", "default": false }, "sortBy": { "title": "Sort videos of each source by", "enum": [ "default", "newest", "oldest", "most-played", "most-liked", "most-commented", "most-shared" ], "type": "string", "description": "Order of the videos within each profile, hashtag or keyword. \"As TikTok lists them\" keeps TikTok's own order.", "default": "default" }, "includeVideoDetail": { "title": "Add full video details", "type": "boolean", "description": "For profiles, hashtags and keywords: also open each video's own page to add the posting country, tagged place, ad flag, caption language and the hashtag list TikTok stores. Video URLs always include them. Billed per video that returned details.", "default": false }, "includeTranscript": { "title": "Add transcript", "type": "boolean", "description": "Add the spoken text of each video from TikTok's own captions (English track first, when there is one). About half of videos carry captions; videos without them come back with an empty transcript and are not billed for it.", "default": false }, "includeComments": { "title": "Add top comments", "type": "boolean", "description": "Add a sample of each video's comments (text, likes, replies, date, commenter). Billed per video that returned at least one comment.", "default": false }, "maxCommentsPerVideo": { "title": "Comments per video", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many comments to add to each video (1 to 100).", "default": 10 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Off by default: TikTok answers most requests directly. If TikTok blocks a request, the Actor steps up to Apify Proxy (datacenter, then residential) on its own. Turn it on to start from a proxy.", "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 } } } } } } } } } }