The following documentation is automatically generated. Please do not edit this file, but rather the original, inline with Net::Async::Spotify::API::Generated::Albums at lib/Net/Async/Spotify/API/Generated/Albums.pm (on the system that originally ran this). If you do edit this file, and don't want your changes to be removed, make sure you change the first line.
NAME
Net::Async::Spotify::API::Generated::Albums - Package representing Spotify Albums API
DESCRIPTION
Autogenerated module. Based on https://developer.spotify.com/documentation/web-api/reference/#reference-index Check crawl-api-doc.pl for more information.
METHODS
get_an_album
get_an_album - Get an Album
Get Spotify catalog information for a single album.
with Request details being:
header
- Authorization
-
Type: string | Required: required A valid user access token or your client credentials.
path_parameter
- id
-
Type: string | Required: required The Spotify ID of the album.
query_parameter
- market
-
Type: string | Required: optional The market you’d like to request. Synonym for country.
and Response Objects being:
- album object
On success, the HTTP status code in the response header is 200 OK and the response body contains an album object in JSON format. On error, the header status code is an error code and the response body contains an error object.Try in our Web Console
get_an_albums_tracks
get_an_albums_tracks - Get an Album's Tracks
Get Spotify catalog information about an album’s tracks. Optional parameters can be used to limit the number of tracks returned.
with Request details being:
header
- Authorization
-
Type: string | Required: required A valid user access token or your client credentials.
path_parameter
- id
-
Type: string | Required: required The Spotify ID of the album.
query_parameter
- limit
-
Type: integer | Required: optional The maximum number of tracks to return. Default: 20. Minimum: 1. Maximum: 50.
- market
-
Type: string | Required: optional An ISO 3166-1 alpha-2 country code or the string from_token. Provide this parameter if you want to apply Track Relinking.
- offset
-
Type: integer | Required: optional The index of the first track to return. Default: 0 (the first object). Use with limit to get the next set of tracks.
and Response Objects being:
- album object
On success, the HTTP status code in the response header is 200 OK and the response body contains an album object in JSON format. On error, the header status code is an error code and the response body contains an error object.Try in our Web Console
get_multiple_albums
get_multiple_albums - Get Multiple Albums
Get Spotify catalog information for multiple albums identified by their Spotify IDs.
with Request details being:
header
- Authorization
-
Type: string | Required: required A valid user access token or your client credentials.
query_parameter
- ids
-
Type: string | Required: required A comma-separated list of the Spotify IDs for the albums. Maximum: 20 IDs.
- market
-
Type: string | Required: optional An ISO 3166-1 alpha-2 country code or the string from_token. Provide this parameter if you want to apply Track Relinking.
and Response Objects being:
- an object - an object
On success, the HTTP status code in the response header is 200 OK and the response body contains an object whose key is "albums" and whose value is an array of album objects in JSON format.Objects are returned in the order requested. If an object is not found, a null value is returned in the appropriate position. Duplicate ids in the query will result in duplicate objects in the response. On error, the header status code is an error code and the response body contains an error object.Try in our Web Console