mirror of
https://github.com/Sarsoo/Spotify.NET.git
synced 2024-12-24 23:16:28 +00:00
31 lines
20 KiB
HTML
31 lines
20 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="viewport" content="width=device-width">
|
||
<meta name="generator" content="Docusaurus v2.0.0-alpha.56">
|
||
<title data-react-helmet="true">Browse | SpotifyAPI-NET</title><meta data-react-helmet="true" name="docsearch:version" content="5.1.1"><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" property="og:title" content="Browse | SpotifyAPI-NET"><meta data-react-helmet="true" name="description" content="GetFeaturedPlaylists"><meta data-react-helmet="true" property="og:description" content="GetFeaturedPlaylists"><meta data-react-helmet="true" property="og:url" content="https://johnnycrazy.github.io/SpotifyAPI-NET/docs/web/browse"><link data-react-helmet="true" rel="shortcut icon" href="/SpotifyAPI-NET/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://johnnycrazy.github.io/SpotifyAPI-NET/docs/web/browse"><link rel="stylesheet" href="/SpotifyAPI-NET/styles.8a053330.css">
|
||
<link rel="preload" href="/SpotifyAPI-NET/styles.20e5fb07.js" as="script">
|
||
<link rel="preload" href="/SpotifyAPI-NET/runtime~main.7016f437.js" as="script">
|
||
<link rel="preload" href="/SpotifyAPI-NET/main.ffe1a9c0.js" as="script">
|
||
<link rel="preload" href="/SpotifyAPI-NET/1.d763968b.js" as="script">
|
||
<link rel="preload" href="/SpotifyAPI-NET/2.c001a4a7.js" as="script">
|
||
<link rel="preload" href="/SpotifyAPI-NET/3.c31fd0fb.js" as="script">
|
||
<link rel="preload" href="/SpotifyAPI-NET/1be78505.6d7d8bd2.js" as="script">
|
||
<link rel="preload" href="/SpotifyAPI-NET/3d0d8a2f.44e5d4a3.js" as="script">
|
||
<link rel="preload" href="/SpotifyAPI-NET/dd053733.587be141.js" as="script">
|
||
</head>
|
||
<body>
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=window.matchMedia("(prefers-color-scheme: dark)"),n=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();null!==n?t(n):e.matches&&t("dark")}()</script><div id="__docusaurus">
|
||
<nav class="navbar navbar--light navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a class="navbar__brand" href="/SpotifyAPI-NET/"><img class="navbar__logo" src="/SpotifyAPI-NET/img/logo.svg" alt="SpotifyAPI-NET"><strong class="navbar__title">SpotifyAPI-NET</strong></a><div class="navbar__item dropdown dropdown--hoverable dropdown--left"><a activeclassname="navbar__link--active" class="navbar__item navbar__link">Docs</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/SpotifyAPI-NET/docs/next/introduction">Latest/Next</a></li><li><a class="dropdown__link" href="/SpotifyAPI-NET/docs/home">5.1.1</a></li></ul></div><a class="navbar__item navbar__link" href="/SpotifyAPI-NET/news">News</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_1gtM"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_keGJ moon_1gwN"></span></div><div class="react-toggle-track-x"><span class="toggle_keGJ sun_3CPA"></span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/SpotifyAPI-NET/"><img class="navbar__logo" src="/SpotifyAPI-NET/img/logo.svg" alt="SpotifyAPI-NET"><strong class="navbar__title">SpotifyAPI-NET</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a activeclassname="navbar__link--active" class="menu__link menu__link--sublist">Docs</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/SpotifyAPI-NET/docs/next/introduction">Latest/Next</a></li><li class="menu__list-item"><a class="menu__link" href="/SpotifyAPI-NET/docs/home">5.1.1</a></li></ul></li><li class="menu__list-item"><a class="menu__link" href="/SpotifyAPI-NET/news">News</a></li><li class="menu__list-item"><a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET" target="_blank" rel="noopener noreferrer" class="menu__link">GitHub</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_1kjD"><div class="docSidebarContainer_1cYp"><div class="sidebar_1kLs"><div class="menu menu--responsive menu_w2sC"><button aria-label="Open Menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_2vk4" xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 32 32" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">SpotifyAPI-NET</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/home">Home</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">SpotifyAPI-NET.Web</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/getting_started">Getting Started</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/albums">Albums</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/artists">Artists</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/SpotifyAPI-NET/docs/web/browse">Browse</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/follow">Follow</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/library">Library</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/personalization">Personalization</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/player">Player</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/playlists">Playlists</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/profiles">Profiles</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/proxy">Proxy Settings</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/search">Search</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/tracks">Tracks</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/web/utilities">Utilities</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#!">SpotifyAPI-NET.Auth</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/auth/getting_started">Getting Started</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/auth/implicit_grant">Implicit Grant</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/auth/authorization_code">Authorization Code</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/auth/client_credentials">Client Credentials</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/SpotifyAPI-NET/docs/auth/token_swap">Token Swap</a></li></ul></li></ul></div></div></div><main class="docMainContainer_FFX1"><div class="container padding-vert--lg docItemWrapper_1cc7"><div class="row"><div class="col docItemCol_2GOA"><div class="docItemContainer_2cwg"><article><div><span class="badge badge--secondary">Version: 5.1.1</span></div><header><h1 class="docTitle_1vWb">Browse</h1></header><div class="markdown"><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="getfeaturedplaylists"></a>GetFeaturedPlaylists<a aria-hidden="true" tabindex="-1" class="hash-link" href="#getfeaturedplaylists" title="Direct link to heading">#</a></h2><blockquote><p>Get a list of Spotify featured playlists (shown, for example, on a Spotify player’s “Browse” tab).</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>[locale]</td><td>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.</td><td><code>"de_DE" //Germany</code></td></tr><tr><td>[country]</td><td>A country: an ISO 3166-1 alpha-2 country code.</td><td><code>"DE"</code></td></tr><tr><td>[timestamp]</td><td>A timestamp in ISO 8601 format</td><td><code>DateTime.Now</code></td></tr><tr><td>[limit]</td><td>The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.</td><td><code>20</code></td></tr><tr><td>[offset]</td><td>The index of the first item to return. Default: 0</td><td><code>0</code></td></tr></tbody></table><p>Returns a <code>FeaturedPlaylists</code> object, which has 2 properties. <code>String Message</code> and <code>Paging<SimplePlaylist> Playlists</code></p><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">FeaturedPlaylists playlists = _spotify.GetFeaturedPlaylists();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">Console.WriteLine(playlists.Message);</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">playlists.Playlists.Items.ForEach(playlist => Console.WriteLine(playlist.Name));</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="getnewalbumreleases"></a>GetNewAlbumReleases<a aria-hidden="true" tabindex="-1" class="hash-link" href="#getnewalbumreleases" title="Direct link to heading">#</a></h2><blockquote><p>Get a list of new album releases featured in Spotify (shown, for example, on a Spotify player’s “Browse” tab).</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>[country]</td><td>A country: an ISO 3166-1 alpha-2 country code.</td><td><code>"DE"</code></td></tr><tr><td>[limit]</td><td>The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.</td><td><code>20</code></td></tr><tr><td>[offset]</td><td>The index of the first item to return. Default: 0</td><td><code>0</code></td></tr></tbody></table><p>Returns a <code>NewAlbumReleases</code> object, which has the property <code>Paging<SimpleAlbum> Albums</code>.</p><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">NewAlbumReleases newAlbums = _spotify.GetNewAlbumReleases();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">newAlbums.Albums.Items.ForEach(album => Console.WriteLine(album.Name));</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="getcategories"></a>GetCategories<a aria-hidden="true" tabindex="-1" class="hash-link" href="#getcategories" title="Direct link to heading">#</a></h2><blockquote><p>Get a list of categories used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab).</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>[country]</td><td>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</td><td><code>"DE"</code></td></tr><tr><td>[locale]</td><td>The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore</td><td><code>"de_DE"</code></td></tr><tr><td>[limit]</td><td>The maximum number of categories to return. Default: 20. Minimum: 1. Maximum: 50.</td><td><code>20</code></td></tr><tr><td>[offset]</td><td>The index of the first item to return. Default: 0 (the first object).</td><td><code>0</code></td></tr></tbody></table><p>Returns a <code>CategoryList</code> object, which has the property <code>Paging<Category> Categories</code>.</p><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">CategoryList categoryList = _spotify.GetCategories();</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">categoryList.Categories.Items.ForEach(category => Console.WriteLine(category.Name));</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="getcategory"></a>GetCategory<a aria-hidden="true" tabindex="-1" class="hash-link" href="#getcategory" title="Direct link to heading">#</a></h2><blockquote><p>Get a single category used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab).</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>categoryId</td><td>The Spotify category ID for the category.</td><td><code>"party"</code></td></tr><tr><td>[country]</td><td>A country: an ISO 3166-1 alpha-2 country code. Provide this parameter to ensure that the category exists for a particular country.</td><td><code>"DE"</code></td></tr><tr><td>[locale]</td><td>The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore</td><td><code>"de_DE"</code></td></tr></tbody></table><p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#category-object" target="_blank" rel="noopener noreferrer">Category</a></p><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">Category cat = _spotify.GetCategory("party");</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">Console.WriteLine(cat.Name);</span></div></div></div></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_ZqCz" id="getcategoryplaylists"></a>GetCategoryPlaylists<a aria-hidden="true" tabindex="-1" class="hash-link" href="#getcategoryplaylists" title="Direct link to heading">#</a></h2><blockquote><p>Get a list of Spotify playlists tagged with a particular category.</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>categoryId</td><td>The Spotify category ID for the category.</td><td><code>"party"</code></td></tr><tr><td>[country]</td><td>A country: an ISO 3166-1 alpha-2 country code.</td><td><code>"DE"</code></td></tr><tr><td>[limit]</td><td>The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.</td><td><code>20</code></td></tr><tr><td>[offset]</td><td>The index of the first item to return. Default: 0</td><td><code>0</code></td></tr></tbody></table><p>Returns a <code>CategoryPlaylist</code> object, which has the property <code>Paging<SimplePlaylist> Playlists</code></p><p><strong>Usage</strong></p><div class="mdxCodeBlock_iHAB"><div class="codeBlockContent_32p_"><button type="button" aria-label="Copy code to clipboard" class="copyButton_1BYj">Copy</button><div tabindex="0" class="prism-code language-csharp codeBlock_19pQ"><div class="codeBlockLines_2n9r" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">CategoryPlaylist playlists = _spotify.GetCategoryPlaylists("party");</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">playlists.Playlists.Items.ForEach(playlist => Console.WriteLine(playlist.Name));</span></div></div></div></div></div><hr></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET/edit/master/SpotifyAPI.Docs/versioned_docs/version-5.1.1/web/browse.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 40 40" style="margin-right:0.3em;vertical-align:sub"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col text--right"><em><small>Last updated on <time datetime="2021-04-08T14:40:11.000Z" class="docLastUpdatedAt_1sqk">4/8/2021</time> by <strong>dependabot[bot]</strong></small></em></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/SpotifyAPI-NET/docs/web/artists"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Artists</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/SpotifyAPI-NET/docs/web/follow"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Follow »</div></a></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_TbNY"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#getfeaturedplaylists" class="table-of-contents__link">GetFeaturedPlaylists</a></li><li><a href="#getnewalbumreleases" class="table-of-contents__link">GetNewAlbumReleases</a></li><li><a href="#getcategories" class="table-of-contents__link">GetCategories</a></li><li><a href="#getcategory" class="table-of-contents__link">GetCategory</a></li><li><a href="#getcategoryplaylists" class="table-of-contents__link">GetCategoryPlaylists</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="text--center"><div>Copyright © 2021 Jonas Dellinger. Built with Docusaurus.</div></div></div></footer></div>
|
||
<script src="/SpotifyAPI-NET/styles.20e5fb07.js"></script>
|
||
<script src="/SpotifyAPI-NET/runtime~main.7016f437.js"></script>
|
||
<script src="/SpotifyAPI-NET/main.ffe1a9c0.js"></script>
|
||
<script src="/SpotifyAPI-NET/1.d763968b.js"></script>
|
||
<script src="/SpotifyAPI-NET/2.c001a4a7.js"></script>
|
||
<script src="/SpotifyAPI-NET/3.c31fd0fb.js"></script>
|
||
<script src="/SpotifyAPI-NET/1be78505.6d7d8bd2.js"></script>
|
||
<script src="/SpotifyAPI-NET/3d0d8a2f.44e5d4a3.js"></script>
|
||
<script src="/SpotifyAPI-NET/dd053733.587be141.js"></script>
|
||
</body>
|
||
</html> |