ArtistApi

class ArtistApi(api: GenericSpotifyApi) : SpotifyEndpoint

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

Api Reference

Constructors

ArtistApi

common

fun ArtistApi(api: GenericSpotifyApi)

Types

AlbumInclusionStrategy

common

enum AlbumInclusionStrategy : Enum<ArtistApi.AlbumInclusionStrategy>

Describes object types to include when finding albumsApi Reference

Functions

getArtist

common

suspend fun getArtist(artist: String): Artist?

Get Spotify catalog information for a single artist identified by their unique Spotify ID.

getArtistAlbums

common

suspend fun getArtistAlbums(artist: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null, vararg include: ArtistApi.AlbumInclusionStrategy): PagingObject<SimpleAlbum>

Get Spotify catalog information about an artist’s albums.

getArtistAlbumsRestAction

common

fun getArtistAlbumsRestAction(artist: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null, vararg include: ArtistApi.AlbumInclusionStrategy): SpotifyRestAction<PagingObject<SimpleAlbum>>

Get Spotify catalog information about an artist’s albums.

getArtistRestAction

common

fun getArtistRestAction(artist: String): SpotifyRestAction<Artist?>

Get Spotify catalog information for a single artist identified by their unique Spotify ID.

getArtists

common

suspend fun getArtists(vararg artists: String): List<Artist?>

Get Spotify catalog information for several artists based on their Spotify IDs.

getArtistsRestAction

common

fun getArtistsRestAction(vararg artists: String): SpotifyRestAction<List<Artist?>>

Get Spotify catalog information for several artists based on their Spotify IDs.

getArtistTopTracks

common

suspend fun getArtistTopTracks(artist: String, market: Market = Market.US): List<Track>

Get Spotify catalog information about an artist’s top tracks by country.

getArtistTopTracksRestAction

common

fun getArtistTopTracksRestAction(artist: String, market: Market = Market.US): SpotifyRestAction<List<Track>>

Get Spotify catalog information about an artist’s top tracks by country.

getRelatedArtists

common

suspend fun getRelatedArtists(artist: String): List<Artist>

Get Spotify catalog information about artists similar to a given artist.

getRelatedArtistsRestAction

common

suspend fun getRelatedArtistsRestAction(artist: String): SpotifyRestAction<List<Artist>>

Get Spotify catalog information about artists similar to a given artist.

Properties

api

common

val api: GenericSpotifyApi

cache

common

val cache: SpotifyCache

Sources

common source