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

BrowseApi

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

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

Api Reference

Constructors

Link copied to clipboard
constructor(api: GenericSpotifyApi)

Properties

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
suspend fun getAvailableGenreSeeds(): List<String>

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

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

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

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

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

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

Link copied to clipboard
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. Recommendations are generated based on the available information for a given seed entity and matched against similar artists and tracks. If there is sufficient information about the provided seeds, a list of tracks will be returned together with pool size details. For artists and tracks that are very new or obscure there might not be enough data to generate a list of tracks.

Link copied to clipboard
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. Recommendations are generated based on the available information for a given seed entity and matched against similar artists and tracks. If there is sufficient information about the provided seeds, a list of tracks will be returned together with pool size details. For artists and tracks that are very new or obscure there might not be enough data to generate a list of tracks.