{
  "openapi": "3.0.1",
  "info": {
    "title": "TikTok Hashtag & Sound Scraper - Videos, Music & Trends",
    "description": "Scrape TikTok hashtags and sounds: hashtag stats, videos posted under a hashtag, sound (music) details, videos that use a sound, trending hashtags by country and the Top 50 / Viral 50 sound charts. Export views, likes, shares, creators and music data to JSON/CSV/Excel.",
    "version": "1.0",
    "x-build-id": "NrN690jshfQtaZnXf"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/vulnv~tiktok-hashtag-music-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-vulnv-tiktok-hashtag-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/vulnv~tiktok-hashtag-music-scraper/runs": {
      "post": {
        "operationId": "runs-sync-vulnv-tiktok-hashtag-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/vulnv~tiktok-hashtag-music-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-vulnv-tiktok-hashtag-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",
        "required": [
          "operation"
        ],
        "properties": {
          "operation": {
            "title": "⚙️ Operation",
            "enum": [
              "hashtag_info",
              "hashtag_videos",
              "music_info",
              "music_videos",
              "trending_hashtags",
              "trending_sounds"
            ],
            "type": "string",
            "description": "What to scrape. Each operation uses a different input field below:\n\n• Hashtag details → Hashtags\n• Hashtag videos → Hashtags\n• Sound details → Sound URLs / IDs\n• Sound videos → Sound URLs / IDs\n• Trending hashtags → Countries\n• Trending sounds → Sound chart",
            "default": "hashtag_videos"
          },
          "hashtags": {
            "title": "#️⃣ Hashtags",
            "type": "array",
            "description": "For the \"Hashtag details\" and \"Videos for a hashtag\" operations. Enter hashtag names with or without # (e.g. booktok, #cat), tiktok.com/tag/... URLs, or numeric hashtag IDs - one per line.",
            "items": {
              "type": "string"
            }
          },
          "musicUrls": {
            "title": "🎵 Sound URLs / IDs",
            "type": "array",
            "description": "For the \"Sound details\" and \"Videos using a sound\" operations. Paste tiktok.com/music/... URLs or numeric sound IDs (e.g. 7000208808676968450) - one per line.",
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "📊 Maximum results per input",
            "minimum": 0,
            "maximum": 5000,
            "type": "integer",
            "description": "Upper bound on results per hashtag / sound / country (and on the sound chart). Cost scales linearly. Set 0 to fetch all available.",
            "default": 100
          },
          "countries": {
            "title": "🌍 Countries",
            "type": "array",
            "description": "For \"Trending hashtags\" only. Two-letter country codes such as US, GB, DE, JP or BR - one per line. Each country returns its own ranking.",
            "default": [
              "US"
            ],
            "items": {
              "type": "string"
            }
          },
          "trendPeriod": {
            "title": "📅 Trend period",
            "enum": [
              "7",
              "30",
              "90"
            ],
            "type": "string",
            "description": "For \"Trending hashtags\" only. Rank hashtags over the last 7, 30 or 90 days.",
            "default": "7"
          },
          "industry": {
            "title": "🏷️ Industry",
            "enum": [
              "all",
              "education",
              "vehicle_transportation",
              "baby_kids_maternity",
              "financial_services",
              "beauty_personal_care",
              "tech_electronics",
              "home_appliances",
              "travel",
              "household_products",
              "pets",
              "apps",
              "home_improvement",
              "apparel_accessories",
              "news_entertainment",
              "business_services",
              "games",
              "life_services",
              "food_beverage",
              "sports_outdoor",
              "health"
            ],
            "type": "string",
            "description": "For \"Trending hashtags\" only. Limit the ranking to hashtags in one industry.",
            "default": "all"
          },
          "soundChart": {
            "title": "📈 Sound chart",
            "enum": [
              "top_50",
              "viral_50"
            ],
            "type": "string",
            "description": "For \"Trending sounds\" only. Top 50 lists the most popular sounds; Viral 50 lists the fastest-rising ones.",
            "default": "top_50"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}