HiRezApi.RealmRoyale
1.2.0
dotnet add package HiRezApi.RealmRoyale --version 1.2.0
NuGet\Install-Package HiRezApi.RealmRoyale -Version 1.2.0
<PackageReference Include="HiRezApi.RealmRoyale" Version="1.2.0" />
paket add HiRezApi.RealmRoyale --version 1.2.0
#r "nuget: HiRezApi.RealmRoyale, 1.2.0"
// Install HiRezApi.RealmRoyale as a Cake Addin
#addin nuget:?package=HiRezApi.RealmRoyale&version=1.2.0
// Install HiRezApi.RealmRoyale as a Cake Tool
#tool nuget:?package=HiRezApi.RealmRoyale&version=1.2.0
HiRez API
A .NET library for interaction with the HiRez API supporting the games Paladins and Realm Royale (SMITE might be added in the future).
- Supports PC, PS4 and Xbox endpoints
- .NET Standard 2.0
- Extensible
Getting started
To get started just install the Paladins NuGet package or Realm Royale NuGet package. If you do not have an auth key request access to the HiRez API.
Usage
Initialize the Paladins client by providing a platform (Pc, Xbox, Ps4) and your API credentials:
var client = new PaladinsApiClient(Platform.Pc, new HiRezApiCredentials("YourDeveloperId", "YourAuthKey"));
Call a specific endpoint synchronous or asynchronous:
var player = client.GetPlayer("bugzy");
player = await client.GetPlayerAsync("bugzy");
Similar for Realm Royale:
Initialize the client by providing a platform (Pc) and your API credentials:
var client = new RealmRoyaleApiClient(Platform.Pc, new HiRezApiCredentials("YourDeveloperId", "YourAuthKey"));
var player = await client.GetPlayerAsync("overpowered");
It's recommended to use the client with a RetryPolicy
to handle transient API failures:
var retryPolicy = new RetryPolicy<HiRezApiRetryStrategy>(new ExponentialBackoffRetryStrategy());
client.SetRetryPolicy(retryPolicy);
Example
Browse into Examples or PaladinsApiTests
Compiling
In order to compile the project, you need at least Visual Studio 2017 (15.3) with C# 7.1 language features.
License
This project is licensed under the MIT License - see the LICENSE file for details
Product | Versions 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. |
-
.NETStandard 2.0
- HiRezApi.Common (>= 1.2.0)
- Microsoft.Rest.ClientRuntime (>= 2.3.11)
- Newtonsoft.Json (>= 11.0.2)
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.2.0 | 989 | 7/2/2018 |
- Initial release