HiRez API

Paladins Realm Royale

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