NAME

WWW::Spotify - Spotify Web API Wrapper

VERSION

version 1.000

SYNOPSIS

use WWW::Spotify ();

# client id and secret default to $ENV{SPOTIFY_CLIENT_ID} and
# $ENV{SPOTIFY_CLIENT_SECRET}; every request sends a bearer token
my $spotify = WWW::Spotify->new();

my $result;

$result = $spotify->album('0sNOF9WDwhWunNAHPD3Baj');

# $result is a json structure, you can operate on it directly
# or you can use the "get" method see below

$result = $spotify->albums_tracks( '6akEvsycLGftJxYudPjmqK',
{
    limit => 1,
    offset => 1

}
);

$result = $spotify->artist( '0LcJLqbBmaGUft1e9Mm8HV' );

$result = $spotify->artist_albums( '1vCWHaC5f2uS3yhpwWbIA6' ,
                    { album_type => 'single',
                      # country => 'US',
                      limit   => 2,
                      offset  => 0
                    }  );

$result = $spotify->track( '0eGsygTp906u18L0Oimnem' );

$result = $spotify->search(
                    'tania bowra' ,
                    'artist' ,
                    { limit => 15 , offset => 0 }
);

my $names = $spotify->get('artists.items[*].name');

# $names is an arrayref of every artist name in the search result

# user-authorized (OAuth authorization code) flow: send the user to
# authorize_url, exchange the returned code, then call /v1/me endpoints

my $url = $spotify->authorize_url( { scope => 'playlist-read-private' } );
my $code = 'CODE';    # the ?code= value Spotify appends to the redirect
$spotify->get_access_token($code);

$result = $spotify->get_current_user_playlists();

my $link = $spotify->get('items[*].href');

foreach my $playlist (@{$link}) {
    $spotify->query_full_url($playlist);
    my $pl_name = $spotify->get('name');
    print "$pl_name\n";
}

DESCRIPTION

Wrapper for the Spotify Web API.

https://developer.spotify.com/web-api/

Have access to a JSON viewer to help develop and debug. The Chrome JSON viewer is very good and provides the exact path of the item within the JSON in the lower left of the screen as you mouse over an element.

UPGRADING FROM 0.017 OR EARLIER

Version 1.000 is a breaking release. Besides removing the methods for endpoints Spotify deleted in November 2024 and February 2026 (the full list with replacements is in the Changes file), three things changed that affect code calling the endpoints that survived:

force_client_auth, result_format, get_oauth_authorize

Removed. Every request now sends a bearer token, so there is nothing to force. Passing force_client_auth to new() is silently ignored by Moo; calling it as a method dies. Use "authorize_url" instead of get_oauth_authorize.
custom_request_handler receives an HTTP::Response

The callback used to get the WWW::Mechanize object. It now gets the HTTP::Response, so $m->status() becomes $res->code and $m->content() becomes $res->decoded_content.
last_result holds UTF-8 bytes

It was previously a character string. Decode it with "decode_json" in JSON::MaybeXS (or set "auto_json_decode") rather than printing it to a :utf8 handle.

CONSTRUCTOR ARGS

ua

You may provide your own user agent object to the constructor. This should be a LWP::UserAgent or a subclass of it. To get extra debugging information, you can do something like this:

use LWP::ConsoleLogger::Easy qw( debug_ua );
use LWP::UserAgent ();
use WWW::Spotify ();

my $ua = LWP::UserAgent->new;
debug_ua( $ua );
my $spotify = WWW::Spotify->new( ua => $ua )

METHODS

auto_json_decode

When true results will be returned as JSON instead of a perl data structure

$spotify->auto_json_decode(1);

get

Returns a specific item or array of items from the JSON result of the last action.

   $result = $spotify->search(
                       'tania bowra' ,
                       'artist' ,
                       { limit => 15 , offset => 0 }
   );

my $image_url = $spotify->get( 'artists.items[0].images[0].url' );

JSON::Path is the underlying library that actually parses the JSON.

query_full_url( $url , [needs o_auth] )

Results from some calls (playlist for example) return full urls that can be in their entirety. This method allows you make a call to that url and use all of the o_auth and other features provided.

$spotify->query_full_url( "https://api.spotify.com/v1/users/spotify/playlists/06U6mm6KPtPIg9D4YGNEnu" , 1 );

album

equivalent to /v1/albums/{id}

$spotify->album('0sNOF9WDwhWunNAHPD3Baj');

used album vs albums since it is a singular request

albums_tracks

equivalent to /v1/albums/{id}/tracks

$spotify->albums_tracks('6akEvsycLGftJxYudPjmqK',
{
    limit => 1,
    offset => 1

}
);

artist

equivalent to /v1/artists/{id}

$spotify->artist( '0LcJLqbBmaGUft1e9Mm8HV' );

used artist vs artists since it is a singular request and avoids collision with "artists" method

artist_albums

equivalent to /v1/artists/{id}/albums

$spotify->artist_albums( '1vCWHaC5f2uS3yhpwWbIA6' ,
                    { album_type => 'single',
                      # country => 'US',
                      limit   => 2,
                      offset  => 0
                    }  );

search

equivalent to /v1/search?type=album (etc)

The query and any extras are UTF-8 encoded before escaping, so pass character strings (decoded text), not UTF-8 bytes.

$spotify->search(
                    'tania bowra' ,
                    'artist' ,
                    { limit => 10 , offset => 0 }
);

Note: as of the February 2026 API changes the maximum limit is 10 (previously 50); use offset to paginate.

track

equivalent to /v1/tracks/{id}

$spotify->track( '0eGsygTp906u18L0Oimnem' );

get_playlist

equivalent to GET /v1/playlists/{playlist_id}

$spotify->get_playlist('37i9dQZF1DXcBWIGoYBM5M');

This method retrieves a playlist owned by a Spotify user. The playlist must be public or owned by the authenticated user.

get_playlist_items

equivalent to /v1/playlists/{playlist_id}/items (renamed from /tracks in the February 2026 API changes)

$spotify->get_playlist_items('37i9dQZF1DXcBWIGoYBM5M', { limit => 10, offset => 0 });

create_playlist

equivalent to POST /v1/me/playlists (replaced /v1/users/{user_id}/playlists in the February 2026 API changes) - creates a playlist for the authenticated user

$spotify->create_playlist('My New Playlist', 1, 'A description of my playlist');

get_current_user_playlists

equivalent to /v1/me/playlists

$spotify->get_current_user_playlists({ limit => 20, offset => 0 });

add_items_to_playlist

equivalent to /v1/playlists/{playlist_id}/items (renamed from /tracks in the February 2026 API changes)

$spotify->add_items_to_playlist('playlist_id', ['spotify:track:4iV5W9uYEdYUVa79Axb7Rh', 'spotify:track:1301WleyT98MSxVHPZCA6M'], 0);

unfollow_playlist

equivalent to DELETE /v1/playlists/{playlist_id}/followers - removes the playlist from the authenticated user's library (Spotify has no hard playlist delete)

$spotify->unfollow_playlist('playlist_id');

get_followed_artists

equivalent to /v1/me/following

$spotify->get_followed_artists(
    limit => 20,
    after => '0I2XqVXqHScXjHhk6AYYRe'
);

Note: This method always sets the 'type' parameter to 'artist' as it's the only supported value.

save_library_items

equivalent to PUT /v1/me/library (February 2026 consolidated library endpoint; replaces the removed PUT /v1/me/tracks, /v1/me/albums, /v1/me/episodes, /v1/me/shows, /v1/me/audiobooks, /v1/me/following and /v1/playlists/{id}/followers endpoints)

Takes Spotify URIs (not bare ids), as a comma-separated string or an array reference. Maximum 40 URIs.

$spotify->save_library_items( [ 'spotify:track:7a3LWj5xSFhFRYmztS8wgK',
                                'spotify:album:4aawyAB9vmqN3uQ7FjRGTy' ] );

remove_library_items

equivalent to DELETE /v1/me/library (February 2026 consolidated library endpoint; replaces the removed per-type DELETE endpoints)

$spotify->remove_library_items( 'spotify:track:7a3LWj5xSFhFRYmztS8wgK' );

check_library_items

equivalent to GET /v1/me/library/contains (February 2026 consolidated library endpoint; replaces the removed per-type */contains endpoints)

$spotify->check_library_items( [ 'spotify:track:7a3LWj5xSFhFRYmztS8wgK' ] );

get_audiobook

equivalent to GET /v1/audiobooks/{id}

$spotify->get_audiobook('7iHfbu1YPACw6oZPAFJtqe');

or with market parameter:

$spotify->get_audiobook('7iHfbu1YPACw6oZPAFJtqe', 'US');

get_users_saved_audiobooks

equivalent to GET /v1/me/audiobooks

$spotify->get_users_saved_audiobooks(20, 0);

get_available_markets

equivalent to GET /v1/markets

$spotify->get_available_markets();

This method retrieves the list of markets where Spotify is available.

get_show

equivalent to GET /v1/shows/{id}

$spotify->get_show('38bS44xjbVVZ3No3ByF1dJ', 'US');

This method retrieves Spotify catalog information for a single show identified by its unique Spotify ID.

get_show_episodes

equivalent to GET /v1/shows/{id}/episodes

$spotify->get_show_episodes('38bS44xjbVVZ3No3ByF1dJ', market => 'US', limit => 10, offset => 5);

This method retrieves Spotify catalog information about a show's episodes. Optional parameters can be used to limit the number of episodes returned.

get_audiobook_chapters

equivalent to GET /v1/audiobooks/{id}/chapters

$spotify->get_audiobook_chapters('3ZXb8FKZGU0EHALYX6uCzU', market => 'US', limit => 50, offset => 0);

This method retrieves the chapters of an audiobook.

send_delete_request

Internal method used to send DELETE requests to the Spotify API.

send_put_request

Internal method used to send PUT requests to the Spotify API.

get_users_saved_shows

equivalent to GET /v1/me/shows

$spotify->get_users_saved_shows(limit => 20, offset => 0);

This method retrieves a list of shows saved in the current Spotify user's library. Optional parameters can be used to limit the number of shows returned.

get_chapter

equivalent to GET /v1/chapters/{id}

$spotify->get_chapter('0D5wENdkdwbqlrHoaJ9g29', market => 'US');

oauth_client_id

needed for requests that require OAuth, see Spotify API documentation for more information

$spotify->oauth_client_id('2xfjijkcjidjkfdi');

Can also be set via environment variable, SPOTIFY_CLIENT_ID

oauth_client_secret

needed for requests that require OAuth, see Spotify API documentation for more information

$spotify->oauth_client_secret('2xfjijkcjidjkfdi');

Can also be set via environment variable, SPOTIFY_CLIENT_SECRET

authorize_url

builds the URL to send a user to for the OAuth authorization-code flow. Uses oauth_client_id and oauth_redirect_uri; scope and state are optional

my $url = $spotify->authorize_url({
    scope => 'user-read-private playlist-modify-private',
    state => $random_string,
});

Open the URL in a browser; after login Spotify redirects to oauth_redirect_uri with a code query parameter.

get_access_token

exchanges an authorization code (from the authorize_url redirect) for a user access token. On success stores current_access_token, refresh_token, and token_expires_at, and returns true

$spotify->get_access_token($code);

refresh_access_token

fetches a new access token using the stored refresh_token (set by get_access_token). Dies if no refresh token is stored; returns true on success

$spotify->refresh_access_token();

refresh_token

the OAuth refresh token, set automatically by get_access_token. Can be set manually to restore a persisted session

$spotify->refresh_token($saved_refresh_token);

response_status

returns the response code for the last request made

my $status = $spotify->response_status();

response_content_type

returns the response type for the last request made, helpful to verify JSON

my $content_type = $spotify->response_content_type();

custom_request_handler

pass a callback subroutine to this method that will be run at the end of the request prior to die_on_response_error, if enabled

# $res is the HTTP::Response object
$spotify->custom_request_handler(
    sub { my $res = shift;
        if ($res->code == 401) {
            return 1;
        }
    }
);

custom_request_handler_result

returns the result of the most recent execution of the custom_request_handler callback this allows you to determine the success/failure criteria of your callback

my $callback_result = $spotify->custom_request_handler_result();

die_on_response_error

Boolean - default 0

added to provide minimal automated checking of responses

$spotify->die_on_response_error(1);

eval { # run assuming you do NOT have proper authentication setup $result = $spotify->album('0sNOF9WDwhWunNAHPD3Baj'); };

if ($@) { warn $spotify->last_error(); }

last_error

returns last_error (if applicable) from the most recent request. reset to empty string on each request

print $spotify->last_error() , "\n";

THANKS

Paul Lamere at The Echo Nest / Spotify

All the great Perl community members that keep Perl fun

Olaf Alders for all his help and support in maintaining this module

AUTHOR

Aaron Johnson aaronjjohnson@gmail.com

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	Go to GitHub issues (only if GitHub is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)