/SetlistNet

Setlist.fm API wrapper written in .NET Core

Primary LanguageC#MIT LicenseMIT

setlist.fm API .NET Core library

C# library to interact with setlist.fm API. It's currently supports all methods listed in the REST Endpoints section, such as setlists search or getting artist by MBID.

Usage

Get the key

First of all, apply for the setlist.fm API key. It's needed for all requests.

Search for setlists

SetlistApi api = new SetlistApi(apiKey);
Setlists setlists = api.SearchSetlists(new Setlist()
{
	// Search for Foo Fighters' setlists of 2004.
	Artist = new Artist("foo fighters"),
	EventDate = "00-00-2004"
});

if (setlists.Count > 0)
{
	// A setlist consists of Sets
	foreach (Set set in setlists[0].Sets)
	{
		// A set can be an encore
		if (set.EncoreSpecified)
			Console.WriteLine("---");
		// ...or can have a special name
		if (!string.IsNullOrEmpty(set.Name))
			Console.WriteLine(set.Name);

		// A set consists of Songs
		foreach (Song song in set.Songs)
		{
			Console.WriteLine(song.Name);
		}
	}

	// You can also use this method for text representation of the setlist
	Util.SetlistToText(setlists[0]);
}

So, you must provide search criteria as Setlist object in this case.

Every search method has a description which says what properties of given object will become part of the search query. Not all properties are necessary, for example: Url or Info.

Search for artists

Artists artists = api.SearchArtists(new Artist("muse"));
foreach (Artist artist in artists)
{
	Console.Write(artist.Name);

	// There may be several performers with the same name - use "Disambiguation" property
	// to get SetlistFM notes and distinguish the right one.
	if (!string.IsNullOrEmpty(artist.Disambiguation))
		Console.Write(", " + artist.Disambiguation);

	// Or simply use this:
	Console.WriteLine(artist.NameWithDisambiguation);
	// It will show just the name of the Artist if there's no disambiguation.
}

Same here. If you want to search for artists (or anything else, because it works the same way), you must provide Artist object with necessary properties.

Internationalization

This feature listed as "experimental" by official documentation and does not work for all cities. However, for the rest of it, you can get localized cities and countries names. The default language is English (en), but you can provide any of the languages Spanish (es), French (fr), German (de), Portuguese (pt), Turkish (tr), Italian (it) or Polish (pl).

SetlistApi api = new SetlistApi(apiKey, "en");
var setlist = api.Setlist("23f6dc3b");
Console.WriteLine(setlist.Venue.City.Name + ", " + setlist.Venue.City.Country.Name);
// Output: New York, United States

// If you pass "es" to the constructor, you will get
api = new SetlistApi(apiKey, "es");
setlist = api.Setlist("23f6dc3b");
Console.WriteLine(setlist.Venue.City.Name + ", " + setlist.Venue.City.Country.Name);
// Output: Nueva York, Estados Unidos

More examples coming soon...

Installation

Nuget: https://www.nuget.org/packages/SetlistNet/

Tests

Coming soon.

Issues and contributions

...are welcome.