BrowseApi

class BrowseApi(api: GenericSpotifyApi) : SpotifyEndpoint

Endpoints for getting playlists and new album releases featured on Spotify’s Browse tab.

Api Reference

Constructors

BrowseApi

common

fun BrowseApi(api: GenericSpotifyApi)

Functions

getAvailableGenreSeeds

common

suspend fun getAvailableGenreSeeds(): List<String>

Retrieve a list of available genres seed parameter values for recommendations.

getAvailableGenreSeedsRestAction

common

fun getAvailableGenreSeedsRestAction(): SpotifyRestAction<List<String>>

Retrieve a list of available genres seed parameter values for recommendations.

getCategory

common

suspend fun getCategory(categoryId: String, market: Market? = null, locale: Locale? = null): SpotifyCategory

Get a single category used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab).

getCategoryList

common

suspend fun getCategoryList(limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, locale: Locale? = null, market: Market? = null): PagingObject<SpotifyCategory>

Get a list of categories used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab).

getCategoryListRestAction

common

fun getCategoryListRestAction(limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, locale: Locale? = null, market: Market? = null): SpotifyRestAction<PagingObject<SpotifyCategory>>

Get a list of categories used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab).

getCategoryRestAction

common

fun getCategoryRestAction(categoryId: String, market: Market? = null, locale: Locale? = null): SpotifyRestAction<SpotifyCategory>

Get a single category used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab).

getFeaturedPlaylists

common

suspend fun getFeaturedPlaylists(limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, locale: Locale? = null, market: Market? = null, timestamp: Long? = null): FeaturedPlaylists

Get a list of Spotify featured playlists (shown, for example, on a Spotify player’s ‘Browse’ tab).

getFeaturedPlaylistsRestAction

common

fun getFeaturedPlaylistsRestAction(limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, locale: Locale? = null, market: Market? = null, timestamp: Long? = null): SpotifyRestAction<FeaturedPlaylists>

Get a list of Spotify featured playlists (shown, for example, on a Spotify player’s ‘Browse’ tab).

getNewReleases

common

suspend fun getNewReleases(limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): PagingObject<SimpleAlbum>

Get a list of new album releases featured in Spotify (shown, for example, on a Spotify player’s “Browse” tab).

getNewReleasesRestAction

common

fun getNewReleasesRestAction(limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): SpotifyRestAction<PagingObject<SimpleAlbum>>

Get a list of new album releases featured in Spotify (shown, for example, on a Spotify player’s “Browse” tab).

getPlaylistsForCategory

common

suspend fun getPlaylistsForCategory(categoryId: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): PagingObject<SimplePlaylist>

Get a list of Spotify playlists tagged with a particular category.

getPlaylistsForCategoryRestAction

common

fun getPlaylistsForCategoryRestAction(categoryId: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): SpotifyRestAction<PagingObject<SimplePlaylist>>

Get a list of Spotify playlists tagged with a particular category.

getRecommendations

common

suspend fun getRecommendations(seedArtists: List<String>? = null, seedGenres: List<String>? = null, seedTracks: List<String>? = null, limit: Int? = api.spotifyApiOptions.defaultLimit, market: Market? = null, targetAttributes: Map<TuneableTrackAttribute<*>, Number> = mapOf(), minAttributes: Map<TuneableTrackAttribute<*>, Number> = mapOf(), maxAttributes: Map<TuneableTrackAttribute<*>, Number> = mapOf()): RecommendationResponse

Create a playlist-style listening experience based on seed artists, tracks and genres.

getRecommendationsRestAction

common

fun getRecommendationsRestAction(seedArtists: List<String>? = null, seedGenres: List<String>? = null, seedTracks: List<String>? = null, limit: Int? = api.spotifyApiOptions.defaultLimit, market: Market? = null, targetAttributes: Map<TuneableTrackAttribute<*>, Number> = mapOf(), minAttributes: Map<TuneableTrackAttribute<*>, Number> = mapOf(), maxAttributes: Map<TuneableTrackAttribute<*>, Number> = mapOf()): SpotifyRestAction<RecommendationResponse>

Create a playlist-style listening experience based on seed artists, tracks and genres.

getTrackRecommendations

common

suspend fun getTrackRecommendations(seedArtists: List<String>? = null, seedGenres: List<String>? = null, seedTracks: List<String>? = null, limit: Int? = api.spotifyApiOptions.defaultLimit, market: Market? = null, targetAttributes: List<TrackAttribute<*>> = listOf(), minAttributes: List<TrackAttribute<*>> = listOf(), maxAttributes: List<TrackAttribute<*>> = listOf()): RecommendationResponse

Create a playlist-style listening experience based on seed artists, tracks and genres.

getTrackRecommendationsRestAction

common

fun getTrackRecommendationsRestAction(seedArtists: List<String>? = null, seedGenres: List<String>? = null, seedTracks: List<String>? = null, limit: Int? = api.spotifyApiOptions.defaultLimit, market: Market? = null, targetAttributes: List<TrackAttribute<*>> = listOf(), minAttributes: List<TrackAttribute<*>> = listOf(), maxAttributes: List<TrackAttribute<*>> = listOf()): SpotifyRestAction<RecommendationResponse>

Create a playlist-style listening experience based on seed artists, tracks and genres.

Properties

api

common

val api: GenericSpotifyApi

cache

common

val cache: SpotifyCache

Sources

common source