Spotify.NET/README.md

71 lines
2.7 KiB
Markdown
Raw Normal View History

2014-01-28 20:01:07 +00:00
2020-06-04 20:32:52 +01:00
<h1 align="center">
<p align="center">SpotifyAPI-NET</p>
<a href="https://johnnycrazy.github.io/SpotifyAPI-NET/">
<img
height="128"
width="128"
src="SpotifyAPI.Docs/static/img/logo.svg"
alt="SpotifyAPI-NET">
</a>
</h1>
2020-11-15 13:08:18 +00:00
![Build SpotifyAPI-NET](https://github.com/JohnnyCrazy/SpotifyAPI-NET/workflows/Build/Test/Release%20SpotifyAPI-NET/badge.svg)
2020-06-29 22:03:33 +01:00
[![License](https://img.shields.io/github/license/JohnnyCrazy/SpotifyAPI-NET?style=flat-square)](./LICENSE)
2020-06-04 20:32:52 +01:00
[![SpotifyAPI.Web NuGET](https://img.shields.io/nuget/vpre/SpotifyAPI.Web?label=SpotifyAPI.Web&style=flat-square)](https://www.nuget.org/packages/SpotifyAPI.Web/)
2020-06-29 22:03:33 +01:00
[![SpotifyAPI.Web.Auth NuGET](https://img.shields.io/nuget/vpre/SpotifyAPI.Web.Auth?label=SpotifyAPI.Web.Auth&style=flat-square)](https://www.nuget.org/packages/SpotifyAPI.Web.Auth/)
2020-06-04 20:32:52 +01:00
This open source library for the Spotify Web API provides an easy to use interface for .NET based languages, like C# and VisualBasic .NET. By using it you can query general spotify catalog information (tracks, albums and playlists), manage user-related content ("My Library", create and edit playlists) and control the users music players (play, stop, transfer playback, play specific track).
### Features
* ✅ Typed responses and requests to over 74 endpoints. Complete and always up to date.
* ✅ Supports `.NET Standard 2.X`, which includes all major platforms, including mobile:
* `.NET Framework`
* `UWP`
* `.NET Core`
* `Xamarin.Forms`
* ✅ Included `HTTPClient`, but feel free to bring your own!
* ✅ Logging supported
* ✅ Retry Handlers supported
* ✅ Proxy support
* ✅ Pagination support
* ✅ All OAuth2 Authentications supported for use in `ASP .NET` **and** `CLI` apps
* ✅ Modular structure, for easy unit testing
2017-05-31 16:22:14 +01:00
2020-06-04 20:32:52 +01:00
### Example
2018-12-22 20:27:43 +00:00
2020-06-04 20:32:52 +01:00
```csharp
using System;
using SpotifyAPI.Web;
2015-07-26 15:36:27 +01:00
2020-06-04 20:32:52 +01:00
class Program
{
static async Task Main()
{
var spotify = new SpotifyClient("YourAccessToken");
2015-07-26 15:36:27 +01:00
2020-06-04 20:32:52 +01:00
var track = await spotify.Tracks.Get("1s6ux0lNiTziSrd7iUAADH");
Console.WriteLine(track.Name);
}
}
2014-12-05 14:18:32 +00:00
```
2018-09-04 13:46:01 +01:00
More examples can be found on [the website](https://johnnycrazy.github.io/SpotifyAPI-NET/docs/introduction) and in the `SpotifyAPI.Web.Examples` directory.
2018-09-04 13:46:01 +01:00
2014-07-20 21:45:22 +01:00
2020-06-04 20:32:52 +01:00
### Docs and Usage
2018-12-22 20:27:43 +00:00
2020-06-04 20:32:52 +01:00
More Information, Installation-Instructions, Examples, Guides can be found at [johnnycrazy.github.io/SpotifyAPI-NET/](http://johnnycrazy.github.io/SpotifyAPI-NET/)
2018-12-22 20:27:43 +00:00
2020-06-04 20:32:52 +01:00
### Installation
Installation Instructions can be found in the [Getting Started Guide](https://johnnycrazy.github.io/SpotifyAPI-NET/docs/getting_started)
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)