{ "openapi": "3.0.1", "info": { "title": "Tiktok Sound Music Scraper", "description": "TikTok Sound / Music Scraper extracts TikTok sound pages, music metadata, and videos using a sound, including captions, creators, stats, and URLs. Use it for trend tracking, viral audio discovery, campaign monitoring, creator research, and analytics.", "version": "0.1", "x-build-id": "eWo4pgeufIZlybMYg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/coregent~tiktok-sound-music-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-coregent-tiktok-sound-music-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/coregent~tiktok-sound-music-scraper/runs": { "post": { "operationId": "runs-sync-coregent-tiktok-sound-music-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/coregent~tiktok-sound-music-scraper/run-sync": { "post": { "operationId": "run-sync-coregent-tiktok-sound-music-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": { "sounds": { "title": "Sounds", "type": "array", "description": "TikTok sound/music URLs or sound IDs to scrape. Accepts full URLs (https://www.tiktok.com/music/original-sound-1234567890123456789) or numeric sound IDs. Duplicates are automatically removed.", "items": { "type": "string" }, "default": [ "https://www.tiktok.com/music/original-sound-7442277701498820385" ] }, "searchKeywords": { "title": "Search Keywords", "type": "array", "description": "Search for sounds/music on TikTok by keyword. Each keyword triggers a search and the discovered sounds are scraped automatically. Use this to find trending or relevant sounds without knowing exact URLs.", "items": { "type": "string" }, "default": [] }, "maxSoundsPerKeyword": { "title": "Max Sounds Per Keyword", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of sounds to scrape from each keyword search result.", "default": 5 }, "maxVideosPerSound": { "title": "Max Videos Per Sound", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of videos to extract per sound.", "default": 50 }, "includeSoundSummary": { "title": "Include Sound Summary", "type": "boolean", "description": "Emit a separate sound summary record with metadata, usage count, top hashtags, and run health fields.", "default": true }, "includeCreatorFields": { "title": "Include Creator Fields", "type": "boolean", "description": "Include creator/author fields (profile URL, follower count, verified status, etc.) on each video record.", "default": true }, "includeVideoFields": { "title": "Include Video Fields", "type": "boolean", "description": "Include video records in the output dataset (one row per video with full metadata).", "default": true }, "deduplicateVideosAcrossSounds": { "title": "Deduplicate Videos Across Sounds", "type": "boolean", "description": "Remove duplicate videos when the same video appears under multiple sounds in a batch run.", "default": false }, "stopOnError": { "title": "Stop On Error", "type": "boolean", "description": "Stop the entire run on the first sound failure. When false, failed sounds are skipped and the run continues.", "default": false }, "debugMode": { "title": "Debug Mode", "type": "boolean", "description": "Enable verbose logging for troubleshooting.", "default": 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 } } } } } } } } } }