{ "openapi": "3.0.1", "info": { "title": "TikTok Scraper - Video Search, Hashtags, Profiles & Sounds", "description": "Scrape TikTok videos by keyword, hashtag, profile or sound, and find creator profiles by keyword. Get views, likes, comments, shares, captions, hashtags, music, country code and author ID, bio and followers. No login or cookies needed. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "mQSjkW1SV84acYns4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clover_folktale~tiktok-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clover_folktale-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/clover_folktale~tiktok-scraper/runs": { "post": { "operationId": "runs-sync-clover_folktale-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/clover_folktale~tiktok-scraper/run-sync": { "post": { "operationId": "run-sync-clover_folktale-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "hashtag", "userPosts", "userSearch", "music" ], "type": "string", "description": "What to scrape: videos found by keyword search, the videos of hashtags, the latest videos of profiles, profiles found by keyword, or the videos that use a sound.", "default": "search" }, "keywords": { "title": "Keywords (mode: search)", "type": "array", "description": "Search keywords; each keyword is a separate search. Falls back to \"skincare\" when empty.", "items": { "type": "string" } }, "hashtags": { "title": "Hashtags (mode: hashtag)", "type": "array", "description": "Hashtags as skincare, #skincare, or a link (https://www.tiktok.com/tag/skincare). Falls back to \"skincare\" when empty.", "items": { "type": "string" } }, "profiles": { "title": "Profiles (mode: userPosts)", "type": "array", "description": "Public profiles as khaby.lame, @khaby.lame, or a link to the profile or to one of its videos. Falls back to \"khaby.lame\" when empty.", "items": { "type": "string" } }, "userKeywords": { "title": "Keywords (mode: userSearch)", "type": "array", "description": "Search keywords; each keyword is a separate profile search. Falls back to \"skincare\" when empty.", "items": { "type": "string" } }, "musics": { "title": "Sounds (mode: music)", "type": "array", "description": "Sound IDs (7016547803243022337) or links such as https://www.tiktok.com/music/Face-Off-7016547803243022337. Falls back to a sample sound when empty.", "items": { "type": "string" } }, "sortType": { "title": "Sort by (mode: search)", "enum": [ "relevance", "most-liked", "latest" ], "type": "string", "description": "Order of the search results.", "default": "relevance" }, "publishTime": { "title": "Published within (mode: search)", "enum": [ "all", "day", "week", "month", "3months", "6months" ], "type": "string", "description": "Only videos published in this period.", "default": "all" }, "region": { "title": "Region (mode: search)", "type": "string", "description": "Two-letter country code sent with the search, such as US, GB or DE. TikTok treats it as a hint: results can still include videos labelled with other countries (see the region field of each video).", "default": "US" }, "maxResults": { "title": "Max results per keyword, hashtag, profile or sound", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum items for each keyword, hashtag, profile or sound (up to 1000). You are charged $0.003 per item returned, plus a $0.005 start fee for each keyword, hashtag, profile or sound. On the free Apify plan a run returns at most 20 results in total; any paid Apify plan removes the limit.", "default": 20 } } }, "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 } } } } } } } } } }