SharpHeroAPI 1.0.0

dotnet add package SharpHeroAPI --version 1.0.0
NuGet\Install-Package SharpHeroAPI -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SharpHeroAPI" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SharpHeroAPI --version 1.0.0
#r "nuget: SharpHeroAPI, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// 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 Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • .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 476 3/19/2020