Spotify.NET/README.md

60 lines
2.2 KiB
Markdown
Raw Normal View History

2017-05-31 16:22:14 +01:00
SpotifyAPI-NET
===
2014-01-28 20:01:07 +00:00
2017-05-31 16:22:14 +01:00
[![Build status](https://ci.appveyor.com/api/projects/status/mxpjhw3uli4q0yx1?svg=true)](https://ci.appveyor.com/project/JohnnyCrazy/spotifyapi-net)
2018-09-04 13:46:22 +01:00
A Wrapper for Spotify's Web API, written in .NET
2014-02-13 17:26:24 +00:00
2015-07-26 15:36:27 +01:00
**Spotify's Web API** ([link](https://developer.spotify.com/web-api/))
> Based on simple REST principles, our Web API endpoints return metadata in JSON format about artists, albums, and tracks directly from the Spotify catalogue.
> The API also provides access to user-related data such as playlists and music saved in a “Your Music” library, subject to users authorization.
2014-07-20 21:45:22 +01:00
2019-01-10 00:06:35 +00:00
**SpotifyAPI.Web** [![Nuget SpotifyAPI.Web](https://badge.fury.io/nu/SpotifyAPI.Web.svg)](https://www.nuget.org/packages/SpotifyAPI.Web/)
2018-12-22 20:27:43 +00:00
> A wrapper around Spotify's Web API, providing sync and async methods to query all possible endpoints. Results are returned as typed class instances, allowing property-based access.
2019-01-10 00:06:35 +00:00
**SpotifyAPI.Web.Auth** [![Nuget SpotifyAPI.Web.Auth](https://badge.fury.io/nu/SpotifyAPI.Web.Auth.svg)](https://www.nuget.org/packages/SpotifyAPI.Web.Auth/)
2018-12-22 20:27:43 +00:00
> A library providing C# implementations of the 3 supported Authentication modes, including `ImplicitGrantAuth`, `AuthorizationCodeAuth` and `CredentialsAuth`
2015-07-26 15:36:27 +01:00
2018-12-22 20:27:43 +00:00
### Docs and Usage
2018-10-01 19:00:22 +01:00
2015-07-26 15:36:27 +01:00
More Information, Installation-Instructions, Examples and API-Reference can be found at [github.io/SpotifyAPI-Net/](http://johnnycrazy.github.io/SpotifyAPI-NET/)
2017-04-09 10:36:47 +01:00
### NuGet
2018-09-04 13:46:01 +01:00
You can add the API to your project via [nuget-package](https://www.nuget.org/packages/SpotifyAPI.Web/):
2014-12-05 14:18:32 +00:00
```
2018-09-04 13:46:01 +01:00
Install-Package SpotifyAPI.Web
Install-Package SpotifyAPI.Web.Auth
2015-07-26 15:36:27 +01:00
//or
2018-09-04 13:46:01 +01:00
Install-Package SpotifyAPI.Web -pre
Install-Package SpotifyAPI.Web.Auth -pre
2014-12-05 14:18:32 +00:00
```
2014-07-20 21:45:22 +01:00
2018-12-22 20:27:43 +00:00
### Example
```c#
using SpotifyAPI.Web.Enums;
using SpotifyAPI.Web.Models;
public static async void Example()
{
SpotifyWebAPI api = new SpotifyWebAPI
{
AccessToken = "XX?X?X",
TokenType = "Bearer"
};
2020-04-25 22:10:28 +01:00
FullTrack track = await api.GetTrackAsync("1eV81a6H4xDdpi8r2C4tQT");
if(!track.HasError()) {
Console.WriteLine(track.Name);
2018-12-22 20:27:43 +00:00
}
}
```
2018-03-26 00:13:14 +01:00
### Donations
If you want to support this project or my work in general, you can donate a buck or two via the link below. However, this will be always optional!
[![Donate Link](./donate.svg)](https://paypal.me/JohnnyCrazy)