SharpHeroAPI 1.0.0
Install-Package SharpHeroAPI -Version 1.0.0
dotnet add package SharpHeroAPI --version 1.0.0
<PackageReference Include="SharpHeroAPI" Version="1.0.0" />
paket add SharpHeroAPI --version 1.0.0
#r "nuget: SharpHeroAPI, 1.0.0"
// Install SharpHeroAPI as a Cake Addin
#addin nuget:?package=SharpHeroAPI&version=1.0.0
// Install SharpHeroAPI as a Cake Tool
#tool nuget:?package=SharpHeroAPI&version=1.0.0
SharpHeroAPI
A C# .NET library for the SuperHero API. Access all your favourite characters!
Sample Code
Before doing any programming you will need an api key. To get one visit https://superheroapi.com/index.html (all you need is a FaceBook account).
Search for a character by name.
When searching by a name, the program will return a list of results. The below example returns a list of characters when searching for "ironman".
SuperHeroClient client = new SuperHeroClient(API_KEY);
List<Character> characters = client.SearchByName("ironman");
foreach (var character in characters)
{
Console.WriteLine(character.name);
}
Console.ReadLine();
Search for a character by ID.
If you want to only retrieve one character instead of a list of them, you can search for one with an ID. To see all character IDs go to https://superheroapi.com/ids.html. The below example searches for the character "ironman".
SuperHeroClient client = new SuperHeroClient(API_KEY);
Character character = client.SearchById(346);
Console.WriteLine(character.name);
Console.ReadLine();
Character Information
Biography Info
In order to get the basic character information, you need to access the "biography" list. The below code shows ironmans fullname.
SuperHeroClient client = new SuperHeroClient(API_KEY);
Character character = client.SearchById(346);
Console.WriteLine(character.biography.fullname);
Console.ReadLine();
You can access other 'biography' info such as 'alteregos' or 'placeofbirth'.
Appearance Info
To get the characters appearance, you need to acces the "appearance" list. The code below shows ironmans gender.
SuperHeroClient client = new SuperHeroClient(API_KEY);
Character character = client.SearchById(346);
Console.WriteLine(character.appearance.gender);
Console.ReadLine();
Again, you can also access other 'appearance' info such as 'eyecolor' or 'haircolor'
Connections Info
To get the characters connections with other groups/characters, you need to acces the "connections" list. The code below shows ironmans relatives.
SuperHeroClient client = new SuperHeroClient(API_KEY);
Character character = client.SearchById(346);
Console.WriteLine(character.connections.relatives);
Console.ReadLine();
You can access a characters group (for example "The Avengers") by using 'groupaffiliation'.
Product | Versions |
---|---|
.NET | net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows |
.NET Core | netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1 |
.NET Standard | netstandard2.0 netstandard2.1 |
.NET Framework | net461 net462 net463 net47 net471 net472 net48 |
MonoAndroid | monoandroid |
MonoMac | monomac |
MonoTouch | monotouch |
Tizen | tizen40 tizen60 |
Xamarin.iOS | xamarinios |
Xamarin.Mac | xamarinmac |
Xamarin.TVOS | xamarintvos |
Xamarin.WatchOS | xamarinwatchos |
-
.NETStandard 2.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.0.0 | 288 | 3/19/2020 |