Spotify.NET/SpotifyAPI.Docs/versioned_docs/version-5.1.1/web/browse.md
Jonas Dellinger fee995f984 Started docs
2020-05-13 18:27:16 +02:00

4.3 KiB
Raw Blame History

id title sidebar_label
browse Browse Browse

GetFeaturedPlaylists

Get a list of Spotify featured playlists (shown, for example, on a Spotify players “Browse” tab).

Parameters

Name Description Example
[locale] The desired language, consisting of a lowercase ISO 639 language code and an uppercase ISO 3166-1 alpha-2 country code, joined by an underscore. "de_DE" //Germany
[country] A country: an ISO 3166-1 alpha-2 country code. "DE"
[timestamp] A timestamp in ISO 8601 format DateTime.Now
[limit] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. 20
[offset] The index of the first item to return. Default: 0 0

Returns a FeaturedPlaylists object, which has 2 properties. String Message and Paging<SimplePlaylist> Playlists

Usage

FeaturedPlaylists playlists = _spotify.GetFeaturedPlaylists();
Console.WriteLine(playlists.Message);
playlists.Playlists.Items.ForEach(playlist => Console.WriteLine(playlist.Name));

GetNewAlbumReleases

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

Parameters

Name Description Example
[country] A country: an ISO 3166-1 alpha-2 country code. "DE"
[limit] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. 20
[offset] The index of the first item to return. Default: 0 0

Returns a NewAlbumReleases object, which has the property Paging<SimpleAlbum> Albums.

Usage

NewAlbumReleases newAlbums = _spotify.GetNewAlbumReleases();
newAlbums.Albums.Items.ForEach(album => Console.WriteLine(album.Name));

GetCategories

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

Parameters

Name Description Example
[country] A country: an ISO 3166-1 alpha-2 country code. Provide this parameter if you want to narrow the list of returned categories to those relevant to a particular country "DE"
[locale] The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore "de_DE"
[limit] The maximum number of categories to return. Default: 20. Minimum: 1. Maximum: 50. 20
[offset] The index of the first item to return. Default: 0 (the first object). 0

Returns a CategoryList object, which has the property Paging<Category> Categories.

Usage

CategoryList categoryList = _spotify.GetCategories();
categoryList.Categories.Items.ForEach(category => Console.WriteLine(category.Name));

GetCategory

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

Parameters

Name Description Example
categoryId The Spotify category ID for the category. "party"
[country] A country: an ISO 3166-1 alpha-2 country code. Provide this parameter to ensure that the category exists for a particular country. "DE"
[locale] The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore "de_DE"

Returns a Category

Usage

Category cat = _spotify.GetCategory("party");
Console.WriteLine(cat.Name);

GetCategoryPlaylists

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

Parameters

Name Description Example
categoryId The Spotify category ID for the category. "party"
[country] A country: an ISO 3166-1 alpha-2 country code. "DE"
[limit] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. 20
[offset] The index of the first item to return. Default: 0 0

Returns a CategoryPlaylist object, which has the property Paging<SimplePlaylist> Playlists

Usage

CategoryPlaylist playlists = _spotify.GetCategoryPlaylists("party");
playlists.Playlists.Items.ForEach(playlist => Console.WriteLine(playlist.Name));