Global

Methods


getAlbum(opts)

Gets album info based on the id of the album

.

Gets album info based on the id of the album

Parameters:
Name Type Description
opts object

Specifies the options object

Properties
Name Type Description
id string

Specifies the spotify album id

Source:
Returns:

The album information

Type
Promise.<object>
Example
Album
{
   album_type: 'album',
   artists: [ [Object] ],
   available_markets: ['AD', 'EC', 'PT', ...],
   copyrights: [ [Object] ],
   external_ids: { upc: '886445352382' },
   external_urls: { spotify: 'https://open.spotify.com/album/{albumId}'}
   ...
}

getAlbums(opts)

Gets albums info based on albums ids specified

.

Gets albums info based on albums ids specified

Parameters:
Name Type Description
opts object

Specifies the options object

Properties
Name Type Description
ids Array.<string>

Specifies the spotify albums ids

Source:
Returns:

The albums information

Type
Promise.<Array.<object>>
Example
Albums
[{
   album_type: 'album',
   artists: [ [Object] ],
   available_markets: ['AD', 'EC', 'PT', ...],
   copyrights: [ [Object] ],
   external_ids: { upc: '886445352382' },
   external_urls: { spotify: 'https://open.spotify.com/album/{albumId}'}
   ...
}]

getAlbumTracks(opts)

Gets the tracks of the album info based on the id of the album

.

Gets the tracks of the album info based on the id of the album

Parameters:
Name Type Description
opts object

Specifies the options object

Properties
Name Type Argument Default Description
id string

Specifies the spotify album id

skip number <optional>
0

Specifies the offset of the items to retrieve

limit number <optional>
20

Specifies the limit of items to retrieve

Source:
Returns:

The album tracks information

Type
Promise.<Array.<object>>
Example
Tracks
[{
   artists: [ [Object] ],
   available_markets: ['AD', 'EC', 'PT', ...],
   copyrights: [ [Object] ],
   disc_number: 1,
   track_number: 1
   ...
}]