spotify-api-kotlin/com.adamratzman.spotify.endpoints.pub/AlbumApi

AlbumApi

class AlbumApi(val api: GenericSpotifyApi) : SpotifyEndpoint(source)

Endpoints for retrieving information about one or more albums from the Spotify catalog.

Api Reference

Constructors

constructor(api: GenericSpotifyApi)

Properties

val api: GenericSpotifyApi

val cache: SpotifyCache

Functions

suspend fun getAlbum(album: String, market: Market? = null): Album?

Get Spotify catalog information for a single album.

suspend fun getAlbums(vararg albums: String, market: Market? = null): List<Album?>

Get Spotify catalog information for multiple albums identified by their Spotify IDs. Albums not found are returned as null inside the ordered list

suspend fun getAlbumTracks(album: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): PagingObject<SimpleTrack>

Get Spotify catalog information about an album’s tracks. Optional parameters can be used to limit the number of tracks returned.