API Reference

search(

$query,

$filter = null,

$scope = null,

$limit = 20,

$ignore_spelling = false

)

Search YouTube Music and return results within the provided category.

Returns

SearchResult[] - List of search results

// Basic search
$results = $yt->search("Oasis Wonderwall");

// Search for specific content type
$albums = $yt->search("Oasis", filter: "albums");

// Search in library
$library_songs = $yt->search("Wonderwall", scope: "library");

get_search_suggestions($query, $detailed_runs = false)

Get search suggestions for a query.

$suggestions = $yt->get_search_suggestions("faded");
$detailed = $yt->get_search_suggestions("faded", detailed_runs: true);

get_home()

Get the home page with music suggestions and recommendations.

Returns

array - Home page content with titled rows of music suggestions

$home = $yt->get_home();

get_artist($channelId)

Get information about an artist including albums, songs, and related content.

$artist = $yt->get_artist("UCR28YDxjDE3ogQROaNdnRbQ");

get_album($browseId)

Get information about an album including tracks and metadata.

$album = $yt->get_album("MPREb_BQZvl0P6ern");

get_song($videoId, $signatureTimestamp = null)

Returns metadata and streaming information about a song or video.

$song = $yt->get_song("kJQP7kiw5Fk");

get_song_info($videoId)

Get basic information about a track, including whether it's a music video or not. (PHP-specific method)

Returns

SongInfo - Basic song information with music flag

$info = $yt->get_song_info("kJQP7kiw5Fk");
if ($info->music) {
    echo "This is a music track";
}

get_lyrics($browseId)

Get lyrics for a song.

$lyrics = $yt->get_lyrics($track->lyrics);

get_user($channelId)

Get information about a user and their public content.

$user = $yt->get_user("UC123456789");

get_library_playlists($limit = 25)

Retrieve playlists from your library.

Returns

PlaylistInfo[] - List of owned playlists

$playlists = $yt->get_library_playlists();

get_library_songs($limit = 25, $validate_responses = false, $order = null)

Get songs from your library (liked videos are not included).

Returns

Track[] - List of songs in library

$songs = $yt->get_library_songs(limit: 50, order: "recently_added");

get_library_albums($limit = 25, $order = null)

Get albums from your library.

Returns

AlbumInfo[] - List of albums

get_library_artists($limit = 25, $order = null)

Get artists from your library.

get_history()

Get your music history.

Returns

Track[] - List of recently played tracks

rate_song($videoId, $rating = "INDIFFERENT")

Rate a song (like, dislike, or indifferent).

$yt->rate_song("kJQP7kiw5Fk", "LIKE");

get_playlist(

$playlistId,

$limit = 100,

$related = false,

$suggestions_limit = 0,

$get_continuations = true

)

Returns information and tracks of a playlist.

Returns

Playlist - Playlist object with tracks and metadata

$playlist = $yt->get_playlist("PLfY7JYgRs-QJZP7zqsKPFMqKJ5qghLqm_");

get_playlist_continuation($playlistId, $token)

Get continuation of playlist tracks for pagination. (PHP-specific method)

// Get first batch
$playlist = $yt->get_playlist("LM", get_continuations: false);

// Get next batch
while ($playlist->continuation) {
    $next = $yt->get_playlist_continuation("LM", $playlist->continuation);
    $playlist->tracks = array_merge($playlist->tracks, $next->tracks);
    $playlist->continuation = $next->continuation;
}

get_liked_songs($limit = 100)

Get your liked songs playlist.

$liked = $yt->get_liked_songs();

create_playlist(

$title,

$description,

$privacy_status = "PRIVATE",

$video_ids = null,

$source_playlist = null

)

Create a new playlist.

$playlist_id = $yt->create_playlist(
    "My Favorite Songs", 
    "Collection of my favorite tracks",
    "PRIVATE",
    ["kJQP7kiw5Fk", "dQw4w9WgXcQ"]
);

edit_playlist(

$playlistId,

$title = null,

$description = null,

$privacyStatus = null,

$moveItem = null,

$addPlaylistId = null,

$addToTop = null

)

Edit playlist properties or add content from another playlist.

delete_playlist($playlistId)

Delete a playlist.

$yt->delete_playlist("PLfY7JYgRs-QJZP7zqsKPFMqKJ5qghLqm_");

add_playlist_items(

$playlistId,

$videoIds = null,

$source_playlist = null,

$duplicates = false

)

Add songs to an existing playlist.

$yt->add_playlist_items(
    "PLfY7JYgRs-QJZP7zqsKPFMqKJ5qghLqm_",
    ["kJQP7kiw5Fk", "dQw4w9WgXcQ"]
);

remove_playlist_items($playlistId, $videos)

Remove songs from a playlist.

get_watch_playlist(

$videoId = null,

$playlistId = null,

$limit = 25,

$radio = false,

$shuffle = false

)

Get a watch list of tracks for continuous playback.

Returns

WatchList - Watch playlist with tracks and related information

// Get watch playlist for a song
$watch = $yt->get_watch_playlist(videoId: "kJQP7kiw5Fk");

// Get radio playlist
$radio = $yt->get_watch_playlist(videoId: "kJQP7kiw5Fk", radio: true);

get_track($videoId)

Get track information including IDs to retrieve lyrics and related tracks. (PHP-specific method)

Returns

WatchTrack - Track object with additional IDs for lyrics and related content

$track = $yt->get_track("kJQP7kiw5Fk");
$lyrics = $yt->get_lyrics($track->lyrics);
$related = $yt->get_song_related($track->related);

get_charts($country = "ZZ")

Get latest charts data from YouTube Music including top videos, artists, and genres.

Returns

array - Charts data with videos, artists, and genres (US-only)

// Get global charts
$global_charts = $yt->get_charts();

// Get US charts (includes genres)
$us_charts = $yt->get_charts("US");

get_mood_categories()

Get available mood categories for music discovery.

$moods = $yt->get_mood_categories();

get_mood_playlists($params)

Get playlists for a specific mood category.

get_library_upload_songs($limit = 25, $order = null)

Get list of uploaded songs from your library.

Returns

UploadTrack[] - List of uploaded songs

$uploads = $yt->get_library_upload_songs();

get_library_upload_albums($limit = 25, $order = null)

Get albums of uploaded songs from your library.

upload_song($filepath)

Upload a song to YouTube Music.

$result = $yt->upload_song("/path/to/song.mp3");

delete_upload_entity($entityId)

Delete a previously uploaded song or album.

get_podcast($playlistId, $limit = 100)

Get information about a podcast and its episodes.

$podcast = $yt->get_podcast("PLgH1bHkDmEYz1234567890");

get_episode($videoId)

Get information about a podcast episode.

Returns

Episode - Episode information including title, description, and metadata

$episode = $yt->get_episode("nDnLSYCOg7E");

get_channel($channelId)

Get information about a podcast channel.