{
  "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": "LYKsekE1tegfxyHsv"
  },
  "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": {
          "inputMode": {
            "title": "Input Mode",
            "enum": [
              "sounds",
              "trending_top",
              "trending_viral"
            ],
            "type": "string",
            "description": "Choose how to start this run:\n\n• Sound URLs / IDs or Keywords — put any mix of TikTok sound/music URLs, numeric sound IDs, and search keywords in the input box below. Each line is detected automatically (URL or ID → that sound is scraped directly; anything else → a keyword search that discovers sounds). All results are combined into one dataset.\n• Trending: Top 50 (global) — scrape TikTok's main global trending chart (the input box is not used).\n• Trending: Viral 50 (global) — scrape TikTok's fast-rising global chart (the input box is not used).\n\nNote: TikTok's public chart is global — there is no per-country or per-period option.",
            "default": "sounds"
          },
          "sounds": {
            "title": "Sound URLs / IDs or Keywords",
            "type": "array",
            "description": "One entry per line — used in \"Sound URLs / IDs or Keywords\" mode. You can freely mix three kinds of entries; each line is auto-detected:\n• TikTok sound/music URL (https://www.tiktok.com/music/original-sound-1234567890123456789) → that sound is scraped.\n• Numeric sound ID (e.g. 1234567890123456789) → that sound is scraped.\n• Anything else → treated as a search keyword; matching sounds are discovered and scraped (up to Max Sounds each).\nAll results are combined into one dataset. Duplicates are removed automatically. Ignored in the Trending modes. If left empty, a demo sound is scraped so you can see example output.",
            "items": {
              "type": "string"
            }
          },
          "maxSounds": {
            "title": "Max Sounds",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many sounds to take from a discovery source: in a keyword search, the maximum sounds per keyword; in a Trending mode, how many chart sounds (top-ranked first). Not used for sound URLs/IDs you provide directly.",
            "default": 10
          },
          "maxVideosPerSound": {
            "title": "Max Videos Per Sound",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Maximum number of videos to extract per sound. Applies to all input modes.",
            "default": 50
          },
          "maxTotalResults": {
            "title": "Max Total Results",
            "minimum": 0,
            "type": "integer",
            "description": "Run-level cap on the total number of video records across all sounds and keywords. The run stops once this many videos have been returned. Set to 0 for no cap.",
            "default": 0
          },
          "onlyPostsNewerThan": {
            "title": "Only Posts Newer Than",
            "enum": [
              "all",
              "1 day",
              "7 days",
              "30 days",
              "90 days"
            ],
            "type": "string",
            "description": "Keep only videos published within this time window. Choose 'All time' for no date filter.",
            "default": "all"
          },
          "minPlayCount": {
            "title": "Minimum Play Count",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only videos with at least this many plays. Set to 0 for no minimum.",
            "default": 0
          },
          "minEngagement": {
            "title": "Minimum Engagement",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only videos whose engagementTotal (likes + comments + shares + saves) is at least this value. Set to 0 for no minimum.",
            "default": 0
          },
          "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
          },
          "includeVideoFields": {
            "title": "Include Video Records",
            "type": "boolean",
            "description": "Include video records in the output dataset (one row per video with full metadata). Turn off to return only the sound summary rows.",
            "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
          },
          "enrichCreators": {
            "title": "Enrich Creator Profiles",
            "type": "boolean",
            "description": "Fetch each creator's full profile to fill follower/following/like counts and bio (fields TikTok omits from the sound's video list). This makes one extra API call per unique creator and is billed separately (creator-detail-result event). When off, these creator fields are returned as null. NOTE: this option requires a paid Apify plan. On the Free plan it is skipped and you are not charged for it — all video and sound results are returned in full.",
            "default": false
          },
          "downloadCovers": {
            "title": "Download Cover Images",
            "type": "boolean",
            "description": "Download each video's cover image and the sound cover into this run's key-value store, and add the stored file URL (videoCoverStoredUrl / soundCoverStoredUrl) to the output. Billed per stored image (media-download-result event). When off, these URL fields are returned as null. Video files are not downloaded.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}