Skip to content

mgkprod/ytmusicapi

Repository files navigation

YTMusicAPI

Latest Version on Packagist MIT Licensed GitHub Tests Action Status Total Downloads

A work-in-progress API that emulates web requests from the YouTube Music web client.

This is a port of sigma67/ytmusicapi, an unofficial API implementation written in Python.

This package being used in production in one of my applications, I will do my best to keep it up to date with the latest evolutions of the YouTube Music client. I don't plan on porting more features than I need using the YouTube Music API into my app. Contributions are open!

Features

Browsing:

  • search (including all filters)
  • get artist information and releases (songs, videos, albums, singles)
  • get user information (videos, playlists)
  • get albums
  • get song metadata
  • get watch playlists (playlist that appears when you press play in YouTube Music)

Requirements

  • PHP 7.4+ and Laravel 8 or higher

Installation

You can install the package via composer:

composer require mgkprod/ytmusicapi

The package will automatically register itself.

You can optionally publish the config file with:

php artisan vendor:publish --provider="MGKProd\YTMusic\YTMusicServiceProvider" --tag="config"

Usage

use MGKProd\YTMusic\Facades\YTMusic;

// search in all
$results = YTMusic::browse()->search('daft punk');

// filtered search (albums, artists, playlists, songs or videos)
$artists = YTMusic::browse()->search('magenta', 'artists');
$songs = YTMusic::browse()->search('blizzard oddscure', 'songs');

// artist
$artist = YTMusic::browse()->artist('MPLAUCmMUZbaYdNH0bEd1PAlAqsA');

// ... and his albums
$albums = YTMusic::browse()->artistAlbums(
    $artist['albums']['browseId'],
    $artist['albums']['params']
);

// ... or his singles
$singles = YTMusic::browse()->artistAlbums(
    $artist['singles']['browseId'],
    $artist['singles']['params']
);

// album
$album = YTMusic::browse()->album('MPREb_BQZvl3BFGay');

// song
$song = YTMusic::browse()->song('ZrOKjDZOtkA');

// user
$user = YTMusic::browse()->user('UCPVhZsC2od1xjGhgEc2NEPQ');

// ... and his playlists
$playlists = YTMusic::browse()->userPlaylists(
    'UCPVhZsC2od1xjGhgEc2NEPQ',
    $user['playlists']['params']
);

The tests are also a great source of usage examples.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email sr@mgk.dev instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.