{ "openapi": "3.0.1", "info": { "title": "🎵 TikTok Sound Scraper", "description": "🎵 TikTok Sound Scraper (tiktok-sound-scraper) pulls trending TikTok sound data fast—captions, URLs & metadata included. 🚀 Perfect for content research, influencer discovery, and music marketing—save time, boost insights, and stay ahead of trends! 🔥", "version": "0.1", "x-build-id": "fFwPYIh10cYx1Nyu5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~tiktok-sound-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-tiktok-sound-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/scraper-engine~tiktok-sound-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-tiktok-sound-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/scraper-engine~tiktok-sound-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-tiktok-sound-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": [ "musics" ], "properties": { "musics": { "title": "🎧 Music / Sound URL(s)", "type": "array", "description": "TikTok music/sound URL(s) to scrape videos from — e.g. https://www.tiktok.com/music/Oh-No-Instrumental-6889520563052645121. You can also paste the slug/ID only, e.g. Oh-No-Instrumental-6889520563052645121. Supports bulk input (one per line).", "items": { "type": "string" } }, "resultsPerPage": { "title": "🔢 Max results per sound", "minimum": 1, "type": "integer", "description": "How many videos to scrape for each sound URL.", "default": 10 }, "downloadSubtitlesOptions": { "title": "📝 Subtitles & Transcription", "enum": [ "NEVER_DOWNLOAD_SUBTITLES", "DOWNLOAD_SUBTITLES", "DOWNLOAD_AND_TRANSCRIBE_VIDEOS_WITHOUT_SUBTITLES", "TRANSCRIBE_ALL_VIDEOS" ], "type": "string", "description": "Choose how to handle subtitles and audio transcription for the scraped videos.", "default": "NEVER_DOWNLOAD_SUBTITLES" }, "shouldDownloadSlideshowImages": { "title": "🖼️ Download slideshow images", "type": "boolean", "description": "Tick to download TikTok slideshow images. Links are saved to the dataset field 'mediaUrls'. Note that this increases cost and time.", "default": false }, "shouldDownloadMusicCovers": { "title": "🎵 Include sound covers", "type": "boolean", "description": "Tick to download cover images of the sounds used in posts. Note that this increases time and cost.", "default": false }, "videoKvStoreIdOrName": { "title": "✍️ Name your media storage", "pattern": "^[a-zA-Z0-9-]+$", "type": "string", "description": "Name (or ID) of the Key-Value store where downloaded media (slideshow images, sound covers, subtitle & transcript files) will be stored. Omit to use the default store. A named store helps bypass data retention and keeps the content until the store is manually deleted. Allowed characters: letters, digits and hyphens (no spaces)." }, "proxyConfiguration": { "title": "🌐 Proxy configuration", "type": "object", "description": "Proxy settings. Leave disabled to start direct with automatic datacenter → residential fallback on blocks.", "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 } } }, "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 } } } } } } } } } }