Skip to content

SpotifyWebAPI.md

Latest commit

 

History

History
1720 lines (869 loc) · 51.6 KB

SpotifyWebAPI.md

File metadata and controls

1720 lines (869 loc) · 51.6 KB

Constants

  • RETURN_ASSOC
  • RETURN_OBJECT

Methods

__construct

 SpotifyWebAPI\SpotifyWebAPI::__construct(\SpotifyWebAPI\Request $request)

Constructor
Set up Request object.

Arguments

  • $request \SpotifyWebAPI\Request - Optional. The Request object to use.

addMyAlbums

boolean SpotifyWebAPI\SpotifyWebAPI::addMyAlbums(string|array $albums)

Add albums to the current user's Spotify library.
https://developer.spotify.com/documentation/web-api/reference/library/save-albums-user/

Arguments

  • $albums string|array - ID(s) or Spotify URI(s) of the album(s) to add.

Return values

  • boolean Whether the albums was successfully added.

addMyTracks

boolean SpotifyWebAPI\SpotifyWebAPI::addMyTracks(string|array $tracks)

Add tracks to the current user's Spotify library.
https://developer.spotify.com/documentation/web-api/reference/library/save-tracks-user/

Arguments

  • $tracks string|array - ID(s) or Spotify URI(s) of the track(s) to add.

Return values

  • boolean Whether the tracks was successfully added.

addPlaylistTracks

boolean SpotifyWebAPI\SpotifyWebAPI::addPlaylistTracks(string $playlistId, string|array $tracks, array|object $options)

Add tracks to a playlist.
https://developer.spotify.com/documentation/web-api/reference/playlists/add-tracks-to-playlist/

Arguments

  • $playlistId string - ID of the playlist to add tracks to.
  • $tracks string|array - ID(s) or Spotify URI(s) of the track(s) to add.
  • $options array|object - Optional. Options for the new tracks.
    • int position Optional. Zero-based track position in playlist. Tracks will be appened if omitted or false.

Return values

  • boolean Whether the tracks was successfully added.

addUserPlaylistTracks

_Deprecated: _

boolean SpotifyWebAPI\SpotifyWebAPI::addUserPlaylistTracks(string $userId, string $playlistId, string|array $tracks, array|object $options)

Arguments

  • $userId string - ID of the user who owns the playlist.
  • $playlistId string - ID of the playlist to add tracks to.
  • $tracks string|array - ID(s) or Spotify URI(s) of the track(s) to add.
  • $options array|object - Optional. Options for the new tracks.
    • int position Optional. Zero-based track position in playlist. Tracks will be appened if omitted or false.

Return values

  • boolean Whether the tracks was successfully added.

changeMyDevice

boolean SpotifyWebAPI\SpotifyWebAPI::changeMyDevice(array|object $options)

Change the current user's playback device.
https://developer.spotify.com/documentation/web-api/reference/player/transfer-a-users-playback/

Arguments

  • $options array|object - Options for the playback transfer.
    • string|array device_ids Required. ID of the device to switch to.
    • bool play Optional. Whether to start playing on the new device

Return values

  • boolean Whether the playback device was successfully changed.

changeVolume

boolean SpotifyWebAPI\SpotifyWebAPI::changeVolume(array|object $options)

Change playback volume for the current user.
https://developer.spotify.com/documentation/web-api/reference/player/set-volume-for-users-playback/

Arguments

  • $options array|object - Optional. Options for the playback volume.
    • int volume_percent Required. The volume to set.
    • string device_id Optional. ID of the device to target.

Return values

  • boolean Whether the playback volume was successfully changed.

createPlaylist

array|object SpotifyWebAPI\SpotifyWebAPI::createPlaylist(array|object $options)

Create a new playlist.
https://developer.spotify.com/documentation/web-api/reference/playlists/create-playlist/

Arguments

  • $options array|object - Options for the new playlist.
    • string name Required. Name of the playlist.
    • bool public Optional. Whether the playlist should be public or not.

Return values

  • array|object The new playlist. Type is controlled by SpotifyWebAPI::setReturnType().

createUserPlaylist

_Deprecated: _

array|object SpotifyWebAPI\SpotifyWebAPI::createUserPlaylist(string $userId, array|object $options)

Arguments

  • $userId string - ID or Spotify URI of the user to create the playlist for.
  • $options array|object - Options for the new playlist.
    • string name Required. Name of the playlist.
    • bool public Optional. Whether the playlist should be public or not.

Return values

  • array|object The new playlist. Type is controlled by SpotifyWebAPI::setReturnType().

currentUserFollows

array SpotifyWebAPI\SpotifyWebAPI::currentUserFollows(string $type, string|array $ids)

Check to see if the current user is following one or more artists or other Spotify users.
https://developer.spotify.com/documentation/web-api/reference/follow/check-current-user-follows/

Arguments

  • $type string - The type to check: either 'artist' or 'user'.
  • $ids string|array - ID(s) or Spotify URI(s) of the user(s) or artist(s) to check for.

Return values

  • array Whether each user or artist is followed.

deleteMyAlbums

boolean SpotifyWebAPI\SpotifyWebAPI::deleteMyAlbums(string|array $albums)

Delete albums from current user's Spotify library.
https://developer.spotify.com/documentation/web-api/reference/library/remove-albums-user/

Arguments

  • $albums string|array - ID(s) or Spotify URI(s) of the album(s) to delete.

Return values

  • boolean Whether the albums was successfully deleted.

deleteMyTracks

boolean SpotifyWebAPI\SpotifyWebAPI::deleteMyTracks(string|array $tracks)

Delete tracks from current user's Spotify library.
https://developer.spotify.com/documentation/web-api/reference/library/remove-tracks-user/

Arguments

  • $tracks string|array - ID(s) or Spotify URI(s) of the track(s) to delete.

Return values

  • boolean Whether the tracks was successfully deleted.

deletePlaylistTracks

string|boolean SpotifyWebAPI\SpotifyWebAPI::deletePlaylistTracks(string $playlistId, array $tracks, string $snapshotId)

Delete tracks from a playlist and retrieve a new snapshot ID.
https://developer.spotify.com/documentation/web-api/reference/playlists/remove-tracks-playlist/

Arguments

  • $playlistId string - ID or Spotify URI of the playlist to delete tracks from.

  • $tracks array - An array with the key "tracks" containing arrays or objects with tracks to delete. Or an array with the key "positions" containing integer positions of the tracks to delete. For legacy reasons, the "tracks" key can be omitted but its use is deprecated. If the "tracks" key is used, the following fields are also available:

    • string id Required. Track ID or Spotify URI.
    • int|array positions Optional. The track's position(s) in the playlist.

  • $snapshotId string - Required when $tracks['positions'] is used, optional otherwise. The playlist's snapshot ID.

Return values

  • string|boolean A new snapshot ID or false if the tracks weren't successfully deleted.

deleteUserPlaylistTracks

_Deprecated: _

string|boolean SpotifyWebAPI\SpotifyWebAPI::deleteUserPlaylistTracks(string $userId, string $playlistId, array $tracks, string $snapshotId)

Arguments

  • $userId string - ID or Spotify URI of the user who owns the playlist.

  • $playlistId string - ID or Spotify URI of the playlist to delete tracks from.

  • $tracks array - An array with the key "tracks" containing arrays or objects with tracks to delete. Or an array with the key "positions" containing integer positions of the tracks to delete. For legacy reasons, the "tracks" key can be omitted but its use is deprecated. If the "tracks" key is used, the following fields are also available:

    • string id Required. Track ID or Spotify URI.
    • int|array positions Optional. The track's position(s) in the playlist.

  • $snapshotId string - Required when $tracks['positions'] is used, optional otherwise. The playlist's snapshot ID.

Return values

  • string|boolean A new snapshot ID or false if the tracks weren't successfully deleted.

followArtistsOrUsers

boolean SpotifyWebAPI\SpotifyWebAPI::followArtistsOrUsers(string $type, string|array $ids)

Add the current user as a follower of one or more artists or other Spotify users.
https://developer.spotify.com/documentation/web-api/reference/follow/follow-artists-users/

Arguments

  • $type string - The type to check: either 'artist' or 'user'.
  • $ids string|array - ID(s) or Spotify URI(s) of the user(s) or artist(s) to follow.

Return values

  • boolean Whether the artist or user was successfully followed.

followPlaylist

_Deprecated: _

boolean SpotifyWebAPI\SpotifyWebAPI::followPlaylist(string $userId, string $playlistId, array|object $options)

Arguments

  • $userId string - ID or Spotify URI of the user who owns the playlist.
  • $playlistId string - ID or Spotify URI of the playlist to follow.
  • $options array|object - Optional. Options for the followed playlist.
    • bool public Optional. Whether the playlist should be followed publicly or not.

Return values

  • boolean Whether the playlist was successfully followed.

followPlaylistForCurrentUser

boolean SpotifyWebAPI\SpotifyWebAPI::followPlaylistForCurrentUser(string $playlistId, array|object $options)

Add the current user as a follower of a playlist.
https://developer.spotify.com/documentation/web-api/reference/follow/follow-playlist/

Arguments

  • $playlistId string - ID or Spotify URI of the playlist to follow.
  • $options array|object - Optional. Options for the followed playlist.
    • bool public Optional. Whether the playlist should be followed publicly or not.

Return values

  • boolean Whether the playlist was successfully followed.

getAlbum

array|object SpotifyWebAPI\SpotifyWebAPI::getAlbum(string $albumId)

Get a album.
https://developer.spotify.com/documentation/web-api/reference/albums/get-album/

Arguments

  • $albumId string - ID or Spotify URI of the album.

Return values

  • array|object The requested album. Type is controlled by SpotifyWebAPI::setReturnType().

getAlbums

array|object SpotifyWebAPI\SpotifyWebAPI::getAlbums(array $albumIds, array|object $options)

Get multiple albums.
https://developer.spotify.com/documentation/web-api/reference/albums/get-several-albums/

Arguments

  • $albumIds array - IDs or Spotify URIs of the albums.
  • $options array|object - Optional. Options for the albums.
    • string market Optional. An ISO 3166-1 alpha-2 country code, provide this if you wish to apply Track Relinking.

Return values

  • array|object The requested albums. Type is controlled by SpotifyWebAPI::setReturnType().

getAlbumTracks

array|object SpotifyWebAPI\SpotifyWebAPI::getAlbumTracks(string $albumId, array|object $options)

Get an album's tracks.
https://developer.spotify.com/documentation/web-api/reference/albums/get-albums-tracks/

Arguments

  • $albumId string - ID or Spotify URI of the album.
  • $options array|object - Optional. Options for the tracks.
    • int limit Optional. Limit the number of tracks.
    • int offset Optional. Number of tracks to skip.
    • string market Optional. An ISO 3166-1 alpha-2 country code, provide this if you wish to apply Track Relinking.

Return values

  • array|object The requested album tracks. Type is controlled by SpotifyWebAPI::setReturnType().

getArtist

array|object SpotifyWebAPI\SpotifyWebAPI::getArtist(string $artistId)

Get an artist.
https://developer.spotify.com/documentation/web-api/reference/artists/get-artist/

Arguments

  • $artistId string - ID or Spotify URI of the artist.

Return values

  • array|object The requested artist. Type is controlled by SpotifyWebAPI::setReturnType().

getArtists

array|object SpotifyWebAPI\SpotifyWebAPI::getArtists(array $artistIds)

Get multiple artists.
https://developer.spotify.com/documentation/web-api/reference/artists/get-several-artists/

Arguments

  • $artistIds array - IDs or Spotify URIs of the artists.

Return values

  • array|object The requested artists. Type is controlled by SpotifyWebAPI::setReturnType().

getArtistRelatedArtists

array|object SpotifyWebAPI\SpotifyWebAPI::getArtistRelatedArtists(string $artistId)

Get an artist's related artists.
https://developer.spotify.com/documentation/web-api/reference/artists/get-related-artists/

Arguments

  • $artistId string - ID or Spotify URI of the artist.

Return values

  • array|object The artist's related artists. Type is controlled by SpotifyWebAPI::setReturnType().

getArtistAlbums

array|object SpotifyWebAPI\SpotifyWebAPI::getArtistAlbums(string $artistId, array|object $options)

Get an artist's albums.
https://developer.spotify.com/documentation/web-api/reference/artists/get-artists-albums/

Arguments

  • $artistId string - ID or Spotify URI of the artist.
  • $options array|object - Optional. Options for the albums.
    • string|array album_type Optional. Album type(s) to return. If omitted, all album types will be returned.
    • string market Optional. Limit the results to items that are playable in this market, for example SE.
    • int limit Optional. Limit the number of albums.
    • int offset Optional. Number of albums to skip.

Return values

  • array|object The artist's albums. Type is controlled by SpotifyWebAPI::setReturnType().

getArtistTopTracks

array|object SpotifyWebAPI\SpotifyWebAPI::getArtistTopTracks(string $artistId, array|object $options)

Get an artist's top tracks in a country.
https://developer.spotify.com/documentation/web-api/reference/artists/get-artists-top-tracks/

Arguments

  • $artistId string - ID or Spotify URI of the artist.
  • $options array|object - Options for the tracks.
    • string $country Required. An ISO 3166-1 alpha-2 country code specifying the country to get the top tracks for.

Return values

  • array|object The artist's top tracks. Type is controlled by SpotifyWebAPI::setReturnType().

getAudioFeatures

array|object SpotifyWebAPI\SpotifyWebAPI::getAudioFeatures(array $trackIds)

Get track audio features.
https://developer.spotify.com/documentation/web-api/reference/tracks/get-several-audio-features/

Arguments

  • $trackIds array - IDs or Spotify URIs of the tracks.

Return values

  • array|object The tracks' audio features. Type is controlled by SpotifyWebAPI::setReturnType().

getAudioAnalysis

object SpotifyWebAPI\SpotifyWebAPI::getAudioAnalysis(string $trackId)

Get audio analysis for track.
https://developer.spotify.com/documentation/web-api/reference/tracks/get-audio-analysis/

Arguments

  • $trackId string - ID or Spotify URI of the track.

Return values

  • object The track's audio analysis. Type is controlled by SpotifyWebAPI::setReturnType().

getCategoriesList

array|object SpotifyWebAPI\SpotifyWebAPI::getCategoriesList(array|object $options)

Get a list of categories used to tag items in Spotify (on, for example, the Spotify player’s "Browse" tab).
https://developer.spotify.com/documentation/web-api/reference/browse/get-list-categories/

Arguments

  • $options array|object - Optional. Options for the categories.
    • string locale Optional. Language to show categories in, for example sv_SE.
    • string country Optional. An ISO 3166-1 alpha-2 country code. Show categories from this country.
    • int limit Optional. Limit the number of categories.
    • int offset Optional. Number of categories to skip.

Return values

  • array|object The list of categories. Type is controlled by SpotifyWebAPI::setReturnType().

getCategory

array|object SpotifyWebAPI\SpotifyWebAPI::getCategory(string $categoryId, array|object $options)

Get a single category used to tag items in Spotify (on, for example, the Spotify player’s "Browse" tab).
https://developer.spotify.com/documentation/web-api/reference/browse/get-category/

Arguments

  • $categoryId string - The Spotify ID of the category.
  • $options array|object - Optional. Options for the category.
    • string locale Optional. Language to show category in, for example sv_SE.
    • string country Optional. An ISO 3166-1 alpha-2 country code. Show category from this country.

Return values

  • array|object The category. Type is controlled by SpotifyWebAPI::setReturnType().

getCategoryPlaylists

array|object SpotifyWebAPI\SpotifyWebAPI::getCategoryPlaylists(string $categoryId, array|object $options)

Get a list of Spotify playlists tagged with a particular category.
https://developer.spotify.com/documentation/web-api/reference/browse/get-categorys-playlists/

Arguments

  • $categoryId string - The Spotify ID of the category.
  • $options array|object - Optional. Options for the category's playlists.
    • string country Optional. An ISO 3166-1 alpha-2 country code. Show category playlists from this country.
    • int limit Optional. Limit the number of playlists.
    • int offset Optional. Number of playlists to skip.

Return values

  • array|object The list of playlists. Type is controlled by SpotifyWebAPI::setReturnType().

getFeaturedPlaylists

array|object SpotifyWebAPI\SpotifyWebAPI::getFeaturedPlaylists(array|object $options)

Get Spotify featured playlists.
https://developer.spotify.com/documentation/web-api/reference/browse/get-list-featured-playlists/

Arguments

  • $options array|object - Optional. Options for the playlists.
    • string locale Optional. Language to show playlists in, for example sv_SE.
    • string country Optional. An ISO 3166-1 alpha-2 country code. Show playlists from this country.
    • string timestamp Optional. A ISO 8601 timestamp. Show playlists relevant to this date and time.
    • int limit Optional. Limit the number of playlists.
    • int offset Optional. Number of playlists to skip.

Return values

  • array|object The featured playlists. Type is controlled by SpotifyWebAPI::setReturnType().

getGenreSeeds

array|object SpotifyWebAPI\SpotifyWebAPI::getGenreSeeds()

Get a list of possible seed genres.
https://developer.spotify.com/documentation/web-api/reference/browse/get-recommendations/

Return values

  • array|object All possible seed genres. Type is controlled by SpotifyWebAPI::setReturnType().

getLastResponse

array SpotifyWebAPI\SpotifyWebAPI::getLastResponse()

Get the latest full response from the Spotify API.

Return values

  • array Response data.
    • array|object body The response body. Type is controlled by SpotifyWebAPI::setReturnType().
    • array headers Response headers.
    • int status HTTP status code.
    • string url The requested URL.

getMyCurrentTrack

array|object SpotifyWebAPI\SpotifyWebAPI::getMyCurrentTrack(array|object $options)

Get the current user’s currently playing track.
https://developer.spotify.com/documentation/web-api/reference/player/get-the-users-currently-playing-track/

Arguments

  • $options array|object - Optional. Options for the track.
    • string market Optional. An ISO 3166-1 alpha-2 country code, provide this if you wish to apply Track Relinking.

Return values

  • array|object The user's currently playing track. Type is controlled by SpotifyWebAPI::setReturnType().

getMyDevices

array|object SpotifyWebAPI\SpotifyWebAPI::getMyDevices()

Get the current user’s devices.
https://developer.spotify.com/documentation/web-api/reference/player/get-a-users-available-devices/

Return values

  • array|object The user's devices. Type is controlled by SpotifyWebAPI::setReturnType().

getMyCurrentPlaybackInfo

array|object SpotifyWebAPI\SpotifyWebAPI::getMyCurrentPlaybackInfo(array|object $options)

Get the current user’s current playback information.
https://developer.spotify.com/documentation/web-api/reference/player/get-information-about-the-users-current-playback/

Arguments

  • $options array|object - Optional. Options for the info.
    • string market Optional. An ISO 3166-1 alpha-2 country code, provide this if you wish to apply Track Relinking.

Return values

  • array|object The user's playback information. Type is controlled by SpotifyWebAPI::setReturnType().

getMyPlaylists

array|object SpotifyWebAPI\SpotifyWebAPI::getMyPlaylists(array|object $options)

Get the current user’s playlists.
https://developer.spotify.com/documentation/web-api/reference/playlists/get-a-list-of-current-users-playlists/

Arguments

  • $options array|object - Optional. Options for the playlists.
    • int limit Optional. Limit the number of playlists.
    • int offset Optional. Number of playlists to skip.

Return values

  • array|object The user's playlists. Type is controlled by SpotifyWebAPI::setReturnType().

getMyRecentTracks

array|object SpotifyWebAPI\SpotifyWebAPI::getMyRecentTracks(array|object $options)

Get the current user’s recently played tracks.
https://developer.spotify.com/documentation/web-api/reference/player/get-recently-played/

Arguments

  • $options array|object - Optional. Options for the tracks.
    • int limit Optional. Number of tracks to return.
    • string after Optional. Unix timestamp in ms (13 digits). Returns all items after this position.
    • string before Optional. Unix timestamp in ms (13 digits). Returns all items before this position.

Return values

  • array|object The most recently played tracks. Type is controlled by SpotifyWebAPI::setReturnType().

getMySavedAlbums

array|object SpotifyWebAPI\SpotifyWebAPI::getMySavedAlbums(array|object $options)

Get the current user’s saved albums.
https://developer.spotify.com/documentation/web-api/reference/library/get-users-saved-albums/

Arguments

  • $options array|object - Optional. Options for the albums.
    • int limit Optional. Number of albums to return.
    • int offset Optional. Number of albums to skip.
    • string market Optional. An ISO 3166-1 alpha-2 country code, provide this if you wish to apply Track Relinking.

Return values

  • array|object The user's saved albums. Type is controlled by SpotifyWebAPI::setReturnType().

getMySavedTracks

array|object SpotifyWebAPI\SpotifyWebAPI::getMySavedTracks(array|object $options)

Get the current user’s saved tracks.
https://developer.spotify.com/documentation/web-api/reference/library/get-users-saved-tracks/

Arguments

  • $options array|object - Optional. Options for the tracks.
    • int limit Optional. Limit the number of tracks.
    • int offset Optional. Number of tracks to skip.
    • string market Optional. An ISO 3166-1 alpha-2 country code, provide this if you wish to apply Track Relinking.

Return values

  • array|object The user's saved tracks. Type is controlled by SpotifyWebAPI::setReturnType().

getMyTop

array|object SpotifyWebAPI\SpotifyWebAPI::getMyTop(string $type, $options)

Get the current user's top tracks or artists.
https://developer.spotify.com/documentation/web-api/reference/personalization/get-users-top-artists-and-tracks/

Arguments

  • $type string - The type of entity to fetch.
  • $options mixed

Return values

  • array|object A list of the requested top entity. Type is controlled by SpotifyWebAPI::setReturnType().

getNewReleases

array|object SpotifyWebAPI\SpotifyWebAPI::getNewReleases(array|object $options)

Get new releases.
https://developer.spotify.com/documentation/web-api/reference/browse/get-list-new-releases/

Arguments

  • $options array|object - Optional. Options for the items.
    • string country Optional. An ISO 3166-1 alpha-2 country code. Show items relevant to this country.
    • int limit Optional. Limit the number of items.
    • int offset Optional. Number of items to skip.

Return values

  • array|object The new releases. Type is controlled by SpotifyWebAPI::setReturnType().

getPlaylist

array|object SpotifyWebAPI\SpotifyWebAPI::getPlaylist(string $playlistId, array|object $options)

Get a specific playlist.
https://developer.spotify.com/documentation/web-api/reference/playlists/get-playlist/

Arguments

  • $playlistId string - ID or Spotify URI of the playlist.
  • $options array|object - Optional. Options for the playlist.
    • string|array fields Optional. A list of fields to return. See Spotify docs for more info.
    • string market Optional. An ISO 3166-1 alpha-2 country code, provide this if you wish to apply Track Relinking.

Return values

  • array|object The user's playlist. Type is controlled by SpotifyWebAPI::setReturnType().

getPlaylistTracks

array|object SpotifyWebAPI\SpotifyWebAPI::getPlaylistTracks(string $playlistId, array|object $options)

Get the tracks in a playlist.
https://developer.spotify.com/documentation/web-api/reference/playlists/get-playlists-tracks/

Arguments

  • $playlistId string - ID or Spotify URI of the playlist.
  • $options array|object - Optional. Options for the tracks.
    • string|array fields Optional. A list of fields to return. See Spotify docs for more info.
    • int limit Optional. Limit the number of tracks.
    • int offset Optional. Number of tracks to skip.
    • string market Optional. An ISO 3166-1 alpha-2 country code, provide this if you wish to apply Track Relinking.

Return values

  • array|object The tracks in the playlist. Type is controlled by SpotifyWebAPI::setReturnType().

getRecommendations

array|object SpotifyWebAPI\SpotifyWebAPI::getRecommendations(array|object $options)

Get recommendations based on artists, tracks, or genres.
https://developer.spotify.com/documentation/web-api/reference/browse/get-recommendations/

Arguments

  • $options array|object - Optional. Options for the recommendations.
    • int limit Optional. Limit the number of recommendations.
    • string market Optional. An ISO 3166-1 alpha-2 country code, provide this if you wish to apply Track Relinking.
    • mixed max_* Optional. Max value for one of the tunable track attributes.
    • mixed min_* Optional. Min value for one of the tunable track attributes.
    • array seed_artists Artist IDs to seed by.
    • array seed_genres Genres to seed by. Call SpotifyWebAPI::getGenreSeeds() for a complete list.
    • array seed_tracks Track IDs to seed by.
    • mixed target_* Optional. Target value for one of the tunable track attributes.

Return values

  • array|object The requested recommendations. Type is controlled by SpotifyWebAPI::setReturnType().

getReturnType

string SpotifyWebAPI\SpotifyWebAPI::getReturnType()

Get a value indicating the response body type.

Return values

  • string A value indicating if the response body is an object or associative array.

getRequest

\SpotifyWebAPI\Request SpotifyWebAPI\SpotifyWebAPI::getRequest()

Get the Request object in use.

Return values

  • \SpotifyWebAPI\Request The Request object in use.

getTrack

array|object SpotifyWebAPI\SpotifyWebAPI::getTrack(string $trackId, array|object $options)

Get a track.
https://developer.spotify.com/documentation/web-api/reference/tracks/get-track/

Arguments

  • $trackId string - ID or Spotify URI of the track.
  • $options array|object - Optional. Options for the track.
    • string market Optional. An ISO 3166-1 alpha-2 country code, provide this if you wish to apply Track Relinking.

Return values

  • array|object The requested track. Type is controlled by SpotifyWebAPI::setReturnType().

getTracks

array|object SpotifyWebAPI\SpotifyWebAPI::getTracks(array $trackIds, array|object $options)

Get multiple tracks.
https://developer.spotify.com/documentation/web-api/reference/tracks/get-several-tracks/

Arguments

  • $trackIds array - IDs or Spotify URIs of the tracks.
  • $options array|object - Optional. Options for the albums.
    • string market Optional. An ISO 3166-1 alpha-2 country code, provide this if you wish to apply Track Relinking.

Return values

  • array|object The requested tracks. Type is controlled by SpotifyWebAPI::setReturnType().

getUser

array|object SpotifyWebAPI\SpotifyWebAPI::getUser(string $userId)

Get a user.
https://developer.spotify.com/documentation/web-api/reference/users-profile/get-users-profile/

Arguments

  • $userId string - ID or Spotify URI of the user.

Return values

  • array|object The requested user. Type is controlled by SpotifyWebAPI::setReturnType().

getUserFollowedArtists

array|object SpotifyWebAPI\SpotifyWebAPI::getUserFollowedArtists(array|object $options)

Get the artists followed by the current user.
https://developer.spotify.com/documentation/web-api/reference/follow/get-followed/

Arguments

  • $options array|object - Optional. Options for the artists.
    • int limit Optional. Limit the number of artists returned.
    • string after Optional. The last artist ID retrieved from the previous request.

Return values

  • array|object A list of artists. Type is controlled by SpotifyWebAPI::setReturnType().

getUserPlaylist

_Deprecated: _

array|object SpotifyWebAPI\SpotifyWebAPI::getUserPlaylist(string $userId, string $playlistId, array|object $options)

Arguments

  • $userId string - ID or Spotify URI of the user.
  • $playlistId string - ID or Spotify URI of the playlist.
  • $options array|object - Optional. Options for the playlist.
    • string|array fields Optional. A list of fields to return. See Spotify docs for more info.
    • string market Optional. An ISO 3166-1 alpha-2 country code, provide this if you wish to apply Track Relinking.

Return values

  • array|object The user's playlist. Type is controlled by SpotifyWebAPI::setReturnType().

getUserPlaylists

array|object SpotifyWebAPI\SpotifyWebAPI::getUserPlaylists(string $userId, array|object $options)

Get a user's playlists.
https://developer.spotify.com/documentation/web-api/reference/playlists/get-list-users-playlists/

Arguments

  • $userId string - ID or Spotify URI of the user.
  • $options array|object - Optional. Options for the tracks.
    • int limit Optional. Limit the number of tracks.
    • int offset Optional. Number of tracks to skip.

Return values

  • array|object The user's playlists. Type is controlled by SpotifyWebAPI::setReturnType().

getUserPlaylistTracks

_Deprecated: _

array|object SpotifyWebAPI\SpotifyWebAPI::getUserPlaylistTracks(string $userId, string $playlistId, array|object $options)

Arguments

  • $userId string - ID or Spotify URI of the user.
  • $playlistId string - ID or Spotify URI of the playlist.
  • $options array|object - Optional. Options for the tracks.
    • string|array fields Optional. A list of fields to return. See Spotify docs for more info.
    • int limit Optional. Limit the number of tracks.
    • int offset Optional. Number of tracks to skip.
    • string market Optional. An ISO 3166-1 alpha-2 country code, provide this if you wish to apply Track Relinking.

Return values

  • array|object The tracks in the playlist. Type is controlled by SpotifyWebAPI::setReturnType().

me

array|object SpotifyWebAPI\SpotifyWebAPI::me()

Get the currently authenticated user.
https://developer.spotify.com/documentation/web-api/reference/users-profile/get-current-users-profile/

Return values

  • array|object The currently authenticated user. Type is controlled by SpotifyWebAPI::setReturnType().

myAlbumsContains

array SpotifyWebAPI\SpotifyWebAPI::myAlbumsContains(string|array $albums)

Check if albums are saved in the current user's Spotify library.
https://developer.spotify.com/documentation/web-api/reference/library/check-users-saved-albums/

Arguments

  • $albums string|array - ID(s) or Spotify URI(s) of the album(s) to check for.

Return values

  • array Whether each album is saved.

myTracksContains

array SpotifyWebAPI\SpotifyWebAPI::myTracksContains(string|array $tracks)

Check if tracks are saved in the current user's Spotify library.
https://developer.spotify.com/documentation/web-api/reference/library/check-users-saved-tracks/

Arguments

  • $tracks string|array - ID(s) or Spotify URI(s) of the track(s) to check for.

Return values

  • array Whether each track is saved.

next

boolean SpotifyWebAPI\SpotifyWebAPI::next(string $deviceId)

Play the next track in the current users's queue.
https://developer.spotify.com/documentation/web-api/reference/player/skip-users-playback-to-next-track/

Arguments

  • $deviceId string - Optional. ID of the device to target.

Return values

  • boolean Whether the track was successfully skipped.

pause

boolean SpotifyWebAPI\SpotifyWebAPI::pause(string $deviceId)

Pause playback for the current user.
https://developer.spotify.com/documentation/web-api/reference/player/pause-a-users-playback/

Arguments

  • $deviceId string - Optional. ID of the device to pause on.

Return values

  • boolean Whether the playback was successfully paused.

play

boolean SpotifyWebAPI\SpotifyWebAPI::play(string $deviceId, array|object $options)

Start playback for the current user.
https://developer.spotify.com/documentation/web-api/reference/player/start-a-users-playback/

Arguments

  • $deviceId string - Optional. ID of the device to play on.
  • $options array|object - Optional. Options for the playback.
    • string context_uri Optional. Spotify URI of the context to play, for example an album.
    • array uris Optional. Spotify track URIs to play.
    • object offset Optional. Indicates from where in the context playback should start.

Return values

  • boolean Whether the playback was successfully started.

previous

boolean SpotifyWebAPI\SpotifyWebAPI::previous(string $deviceId)

Play the previous track in the current users's queue.
https://developer.spotify.com/documentation/web-api/reference/player/skip-users-playback-to-previous-track/

Arguments

  • $deviceId string - Optional. ID of the device to target.

Return values

  • boolean Whether the track was successfully skipped.

reorderPlaylistTracks

string|boolean SpotifyWebAPI\SpotifyWebAPI::reorderPlaylistTracks(string $playlistId, array|object $options)

Reorder the tracks in a playlist.
https://developer.spotify.com/documentation/web-api/reference/playlists/reorder-playlists-tracks/

Arguments

  • $playlistId string - ID or Spotify URI of the playlist.
  • $options array|object - Options for the new tracks.
    • int range_start Required. Position of the first track to be reordered.
    • int range_length Optional. The amount of tracks to be reordered.
    • int insert_before Required. Position where the tracks should be inserted.
    • string snapshot_id Optional. The playlist's snapshot ID.

Return values

  • string|boolean A new snapshot ID or false if the tracks weren't successfully reordered.

reorderUserPlaylistTracks

_Deprecated: _

string|boolean SpotifyWebAPI\SpotifyWebAPI::reorderUserPlaylistTracks(string $userId, string $playlistId, array|object $options)

Arguments

  • $userId string - ID or Spotify URI of the user.
  • $playlistId string - ID or Spotify URI of the playlist.
  • $options array|object - Options for the new tracks.
    • int range_start Required. Position of the first track to be reordered.
    • int range_length Optional. The amount of tracks to be reordered.
    • int insert_before Required. Position where the tracks should be inserted.
    • string snapshot_id Optional. The playlist's snapshot ID.

Return values

  • string|boolean A new snapshot ID or false if the tracks weren't successfully reordered.

repeat

boolean SpotifyWebAPI\SpotifyWebAPI::repeat(array|object $options)

Set repeat mode for the current user’s playback.
https://developer.spotify.com/documentation/web-api/reference/player/set-repeat-mode-on-users-playback/

Arguments

  • $options array|object - Optional. Options for the playback repeat mode.
    • string state Required. The repeat mode. See Spotify docs for possible values.
    • string device_id Optional. ID of the device to target.

Return values

  • boolean Whether the playback repeat mode was successfully changed.

replacePlaylistTracks

boolean SpotifyWebAPI\SpotifyWebAPI::replacePlaylistTracks(string $playlistId, string|array $tracks)

Replace all tracks in a playlist with new ones.
https://developer.spotify.com/documentation/web-api/reference/playlists/replace-playlists-tracks/

Arguments

  • $playlistId string - ID or Spotify URI of the playlist.
  • $tracks string|array - ID(s) or Spotify URI(s) of the track(s) to add.

Return values

  • boolean Whether the tracks was successfully replaced.

replaceUserPlaylistTracks

_Deprecated: _

boolean SpotifyWebAPI\SpotifyWebAPI::replaceUserPlaylistTracks(string $userId, string $playlistId, string|array $tracks)

Arguments

  • $userId string - ID or Spotify URI of the user.
  • $playlistId string - ID or Spotify URI of the playlist.
  • $tracks string|array - ID(s) or Spotify URI(s) of the track(s) to add.

Return values

  • boolean Whether the tracks was successfully replaced.

search

array|object SpotifyWebAPI\SpotifyWebAPI::search(string $query, string|array $type, array|object $options)

Search for an item.
https://developer.spotify.com/documentation/web-api/reference/search/search/

Arguments

  • $query string - The term to search for.
  • $type string|array - The type of item to search for.
  • $options array|object - Optional. Options for the search.
    • string market Optional. Limit the results to items that are playable in this market, for example SE.
    • int limit Optional. Limit the number of items.
    • int offset Optional. Number of items to skip.

Return values

  • array|object The search results. Type is controlled by SpotifyWebAPI::setReturnType().

seek

boolean SpotifyWebAPI\SpotifyWebAPI::seek(array|object $options)

Change playback position for the current user.
https://developer.spotify.com/documentation/web-api/reference/player/seek-to-position-in-currently-playing-track/

Arguments

  • $options array|object - Optional. Options for the playback seeking.
    • string position_ms Required. The position in milliseconds to seek to.
    • string device_id Optional. ID of the device to target.

Return values

  • boolean Whether the playback position was successfully changed.

setAccessToken

void SpotifyWebAPI\SpotifyWebAPI::setAccessToken(string $accessToken)

Set the access token to use.

Arguments

  • $accessToken string - The access token.

Return values

  • void

setReturnType

void SpotifyWebAPI\SpotifyWebAPI::setReturnType(string $returnType)

Set the return type for the response body.

Arguments

  • $returnType string - One of the SpotifyWebAPI::RETURN_* constants.

Return values

  • void

shuffle

boolean SpotifyWebAPI\SpotifyWebAPI::shuffle(array|object $options)

Set shuffle mode for the current user’s playback.
https://developer.spotify.com/documentation/web-api/reference/player/toggle-shuffle-for-users-playback/

Arguments

  • $options array|object - Optional. Options for the playback shuffle mode.
    • bool state Required. The shuffle mode. See Spotify docs for possible values.
    • string device_id Optional. ID of the device to target.

Return values

  • boolean Whether the playback shuffle mode was successfully changed.

unfollowArtistsOrUsers

boolean SpotifyWebAPI\SpotifyWebAPI::unfollowArtistsOrUsers(string $type, string|array $ids)

Remove the current user as a follower of one or more artists or other Spotify users.
https://developer.spotify.com/documentation/web-api/reference/follow/unfollow-artists-users/

Arguments

  • $type string - The type to check: either 'artist' or 'user'.
  • $ids string|array - ID(s) or Spotify URI(s) of the user(s) or artist(s) to unfollow.

Return values

  • boolean Whether the artist(s) or user(s) were successfully unfollowed.

unfollowPlaylist

_Deprecated: _

boolean SpotifyWebAPI\SpotifyWebAPI::unfollowPlaylist(string $userId, string $playlistId)

Arguments

  • $userId string - ID or Spotify URI of the user who owns the playlist.
  • $playlistId string - ID or Spotify URI of the playlist to unfollow

Return values

  • boolean Whether the playlist was successfully unfollowed.

unfollowPlaylistForCurrentUser

boolean SpotifyWebAPI\SpotifyWebAPI::unfollowPlaylistForCurrentUser(string $playlistId)

Remove the current user as a follower of a playlist.
https://developer.spotify.com/documentation/web-api/reference/follow/unfollow-playlist/

Arguments

  • $playlistId string - ID or Spotify URI of the playlist to unfollow

Return values

  • boolean Whether the playlist was successfully unfollowed.

updatePlaylist

boolean SpotifyWebAPI\SpotifyWebAPI::updatePlaylist(string $playlistId, array|object $options)

Update the details of a playlist.
https://developer.spotify.com/documentation/web-api/reference/playlists/change-playlist-details/

Arguments

  • $playlistId string - ID or Spotify URI of the playlist to update.
  • $options array|object - Options for the playlist.
    • collaborative bool Optional. Whether the playlist should be collaborative or not.
    • description string Optional. Description of the playlist.
    • name string Optional. Name of the playlist.
    • public bool Optional. Whether the playlist should be public or not.

Return values

  • boolean Whether the playlist was successfully updated.

updateUserPlaylist

boolean SpotifyWebAPI\SpotifyWebAPI::updateUserPlaylist(string $userId, string $playlistId, array|object $options)

Update the details of a user's playlist.
https://developer.spotify.com/documentation/web-api/reference/playlists/change-playlist-details/

Arguments

  • $userId string - ID or Spotify URI of the user who owns the playlist.
  • $playlistId string - ID or Spotify URI of the playlist to update.
  • $options array|object - Options for the playlist.
    • collaborative bool Optional. Whether the playlist should be collaborative or not.
    • description string Optional. Description of the playlist.
    • name string Optional. Name of the playlist.
    • public bool Optional. Whether the playlist should be public or not.

Return values

  • boolean Whether the playlist was successfully updated.

updatePlaylistImage

boolean SpotifyWebAPI\SpotifyWebAPI::updatePlaylistImage(string $playlistId, $imageData)

Update the image of a playlist.
https://developer.spotify.com/documentation/web-api/reference/playlists/upload-custom-playlist-cover/

Arguments

  • $playlistId string - ID or Spotify URI of the playlist to update.
  • $imageData mixed

Return values

  • boolean Whether the playlist was successfully updated.

updateUserPlaylistImage

_Deprecated: _

boolean SpotifyWebAPI\SpotifyWebAPI::updateUserPlaylistImage(string $userId, string $playlistId, $imageData)

Arguments

  • $userId string - ID or Spotify URI of the user who owns the playlist.
  • $playlistId string - ID or Spotify URI of the playlist to update.
  • $imageData mixed

Return values

  • boolean Whether the playlist was successfully updated.

userFollowsPlaylist

_Deprecated: _

array SpotifyWebAPI\SpotifyWebAPI::userFollowsPlaylist(string $userId, string $playlistId, array|object $options)

Arguments

  • $userId string - User ID or Spotify URI of the playlist owner.
  • $playlistId string - ID or Spotify URI of the playlist.
  • $options array|object - Options for the check.
    • ids string|array Required. ID(s) or Spotify URI(s) of the user(s) to check for.

Return values

  • array Whether each user is following the playlist.

usersFollowPlaylist

array SpotifyWebAPI\SpotifyWebAPI::usersFollowPlaylist(string $playlistId, array|object $options)

Check if a set of users are following a playlist.
https://developer.spotify.com/documentation/web-api/reference/follow/check-user-following-playlist/

Arguments

  • $playlistId string - ID or Spotify URI of the playlist.
  • $options array|object - Options for the check.
    • ids string|array Required. ID(s) or Spotify URI(s) of the user(s) to check for.

Return values

  • array Whether each user is following the playlist.