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

ArtistApi

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

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

Api Reference

Constructors

Link copied to clipboard
constructor(api: GenericSpotifyApi)

Types

Link copied to clipboard
enum AlbumInclusionStrategy : Enum<ArtistApi.AlbumInclusionStrategy>

Describes object types to include when finding albums

Properties

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
suspend fun getArtist(artist: String): Artist?

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

Link copied to clipboard
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.

Link copied to clipboard
suspend fun getArtists(vararg artists: String): List<Artist?>

Get Spotify catalog information for several artists based on their Spotify IDs. Artists not found are returned as null inside the ordered list

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

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

Link copied to clipboard
suspend fun getRelatedArtists(artist: String): List<Artist>

Get Spotify catalog information about artists similar to a given artist. Similarity is based on analysis of the Spotify community’s listening history.