{ "openapi": "3.0.1", "info": { "title": "TikTok Sound Scraper - Music Metadata & Videos", "description": "Scrape TikTok sound metadata, audio preview links, artist details, usage counts, and videos using a sound. Provider-backed with ScrapeCreators primary and SociaVault fallback.", "version": "0.1", "x-build-id": "nZMq161ZG1nPevXyi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~tiktok-sound-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-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/khadinakbar~tiktok-sound-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-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/khadinakbar~tiktok-sound-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-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", "properties": { "soundUrls": { "title": "TikTok Music URLs", "type": "array", "description": "TikTok sound/music URLs. Example: https://www.tiktok.com/music/luther-7439295283975702544", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Alternative Apify-style URL input. Add TikTok /music/ URLs here if you prefer request-list input.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "clipIds": { "title": "Clip IDs", "type": "array", "description": "Raw TikTok sound clip IDs. The clip ID is the long numeric ID at the end of a TikTok /music/ URL.", "items": { "type": "string" } }, "searchQueries": { "title": "Music Search Queries", "type": "array", "description": "Optional TikTok music search queries. Search uses SociaVault's TikTok music search endpoint and then scrapes each discovered sound.", "items": { "type": "string" } }, "outputMode": { "title": "Output Mode", "enum": [ "sounds_and_videos", "sounds", "videos" ], "type": "string", "description": "Choose whether to save sound metadata, videos using the sound, or both.", "default": "sounds_and_videos" }, "providerOrder": { "title": "Provider Order", "enum": [ "scrapecreators-first", "sociavault-first", "scrapecreators-only", "sociavault-only" ], "type": "string", "description": "Choose which provider is tried first for sound details and videos. ScrapeCreators is the recommended primary. SociaVault is required for search queries.", "default": "scrapecreators-first" }, "maxSounds": { "title": "Max Sounds", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of unique sounds to process across direct inputs and search results.", "default": 25 }, "maxSearchResultsPerQuery": { "title": "Max Search Results Per Query", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of TikTok sounds discovered from each search query.", "default": 10 }, "maxVideosPerSound": { "title": "Max Videos Per Sound", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum videos to save for each sound. Set 0 to save sound metadata only.", "default": 100 }, "maxPagesPerSound": { "title": "Max Provider Pages Per Sound", "minimum": 1, "maximum": 500, "type": "integer", "description": "Safety cap for provider pagination while collecting videos using a sound.", "default": 20 }, "region": { "title": "Search Region", "type": "string", "description": "Alpha-2 country code used for SociaVault music search. Direct clip ID scraping does not require a region.", "default": "US" }, "filterBy": { "title": "Search Filter", "enum": [ "0", "1", "2" ], "type": "string", "description": "SociaVault music search filter: 0 all, 1 title, 2 creators.", "default": "0" }, "sortType": { "title": "Search Sort", "enum": [ "0", "1", "2", "3", "4" ], "type": "string", "description": "SociaVault music search sort: 0 relevance, 1 most used, 2 most recent, 3 shortest, 4 longest.", "default": "0" }, "includeRawData": { "title": "Include Raw Provider Data", "type": "boolean", "description": "Include raw provider payloads on each row for debugging and custom downstream parsing.", "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 } } } } } } } } } }