Camille.RiotGames 3.0.0-nightly-2022-01-19-e2d99a371d

This is a prerelease version of Camille.RiotGames.
Install-Package Camille.RiotGames -Version 3.0.0-nightly-2022-01-19-e2d99a371d
dotnet add package Camille.RiotGames --version 3.0.0-nightly-2022-01-19-e2d99a371d
<PackageReference Include="Camille.RiotGames" Version="3.0.0-nightly-2022-01-19-e2d99a371d" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Camille.RiotGames --version 3.0.0-nightly-2022-01-19-e2d99a371d
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Camille.RiotGames, 3.0.0-nightly-2022-01-19-e2d99a371d"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Camille.RiotGames as a Cake Addin
#addin nuget:?package=Camille.RiotGames&version=3.0.0-nightly-2022-01-19-e2d99a371d&prerelease

// Install Camille.RiotGames as a Cake Tool
#tool nuget:?package=Camille.RiotGames&version=3.0.0-nightly-2022-01-19-e2d99a371d&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Camille

Github Actions NuGet Stable NuGet Pre Release API Reference

C# Library for the Riot Games API

Camille's goals are speed, reliability, and maintainability. Camille handles rate limits and large requests with ease. Data classes are automatically generated from the Riot API Reference (Swagger).

Features

  • Fast, asynchronous, thread-safe.
  • Automatically retries failed requests.
  • Automatic up-to-date nightlies, reflecting Riot API changes within 24 hours.
  • Multi-targeted: .NET Standard 1.1+, .NET Framework 4.5+, .NET Core 2.0, .NET Standard 2.1+, .NET Core 3.0+.
  • Highly-configurable.
  • Riot API LOL-V4, TFT, LOR support.
  • C# 8 nullable support.

Installation

Install via NuGet (Camille.RiotGames).

Type the following in the package manager console:

Install-Package Camille.RiotGames -IncludePrerelease

Or use the .NET CLI:

dotnet add package Camille.RiotGames --prerelease

Usage

All API interactions are done using a RiotApi instance. RiotApi.NewInstance takes either just an API key (for default settings) or a IRiotApiConfig instance (for custom settings).

var riotApi = RiotApi.NewInstance("RGAPI-12345678-abcd-1234-abcd-123456abcdef");
// OR
var riotApi = RiotApi.NewInstance(
    new RiotApiConfig.Builder("RGAPI-12345678-abcd-1234-abcd-123456abcdef")
    {
        MaxConcurrentRequests = 200,
        Retries = 10,
        // ...
    }.Build()
);

You can find all configuration options here.

API methods are divided up into respective endpoints, corresponding to the left bar of the API reference.

Example

Print Summoner's Top Champions
// Get summoners by name synchronously. (Note: async is faster as it allows simultaneous requests).
var summoners = new[]
{
    riotApi.SummonerV4().GetBySummonerName(PlatformRoute.NA1, "jAnna kendrick"),
    riotApi.SummonerV4().GetBySummonerName(PlatformRoute.NA1, "lug nuts k")
};

foreach (var summoner in summoners)
{
    Console.WriteLine($"{summoner.Name}'s Top 10 Champs:");

    var masteries =
        riotApi.ChampionMasteryV4().GetAllChampionMasteries(PlatformRoute.NA1, summoner.Id);

    for (var i = 0; i < 10; i++)
    {
        var mastery = masteries[i];
        // Get champion for this mastery.
        var champ = (Champion) mastery.ChampionId;
        // print i, champ id, champ mastery points, and champ level
        Console.WriteLine("{0,3}) {1,-16} {2,10:N0} ({3})", i + 1, champ.ToString(),
            mastery.ChampionPoints, mastery.ChampionLevel);
    }
    Console.WriteLine();
}

Output (2022-01-17):

Janna Kendrick's Top 10 Champs:
  1) EKKO              1,803,701 (7)
  2) PYKE                266,410 (7)
  3) SYLAS               193,439 (7)
  4) MASTERYI            134,140 (7)
  5) MORDEKAISER         127,937 (7)
  6) YASUO                93,904 (7)
  7) VIEGO                88,267 (7)
  8) AHRI                 82,106 (7)
  9) JINX                 76,788 (6)
 10) POPPY                74,982 (7)
    
LugnutsK's Top 10 Champs:
  1) ZYRA                841,132 (7)
  2) SORAKA               81,793 (6)
  3) MORGANA              62,917 (5)
  4) SONA                 55,073 (6)
  5) NAMI                 49,917 (6)
  6) JANNA                46,563 (5)
  7) BRAND                46,401 (5)
  8) TARIC                41,302 (6)
  9) EKKO                 40,245 (5)
 10) POPPY                33,859 (5)

API Reference

Automatically generated API Reference

Source Code

Source code is located in the src/ directory, corresponding to the MingweiSamuel.Camille namespace.

RiotApi.cs is the main point of entry for interfacing with Camille, however this source file is only a partial class. The remainder of the class is automatically generated and not commited to the master branch, but is viewable as described below in the "Generated Classes" section.

Files in the src/util directory/MingweiSamuel.Camille.Util namespace are internal classes used for sending requests and handling rate limits.

Generated Classes

The majority of the code in Camille is automatically generated. The generated sources are not commited to the master branch, but are available in the gh-pages branch in the _gen/ directory.

GeneratedClasses.cs contains all endpoints, and therefore endpoint methods, as well as all the data transfer objects corresponding to the JSON returned by the Riot API.

Champion.cs is an enum for working with champion IDs.

RiotApiConfig.cs is the configuration builder code for creating RiotApi instnaces with custom settings.

The actual code for generating these classes is in the src/gen folder. The C#-generating code is in *.cs.dt files and is written in NodeJS, using doT.js templates.

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
3.0.0-nightly-2022-01-19-e2... 0 1/19/2022
3.0.0-nightly-2021-12-30-6d... 34 12/30/2021
3.0.0-nightly-2021-11-20-c5... 390 11/20/2021
3.0.0-nightly-2021-11-20-93... 396 11/20/2021
3.0.0-nightly-2021-11-11-93... 55 11/11/2021
3.0.0-nightly-2021-10-24-93... 89 10/24/2021
3.0.0-nightly-2021-10-24-5b... 145 10/24/2021
3.0.0-nightly-2021-10-13-2d... 53 10/13/2021
3.0.0-nightly-2021-10-10-47... 138 10/10/2021
3.0.0-nightly-2021-10-02-52... 90 10/2/2021
3.0.0-nightly-2021-09-10-6f... 88 9/10/2021
3.0.0-nightly-2021-09-04-6f... 34 9/4/2021
3.0.0-nightly-2021-08-25-6f... 56 8/25/2021
3.0.0-nightly-2021-07-24-14... 179 7/24/2021
3.0.0-nightly-2021-07-23-14... 76 7/23/2021
3.0.0-nightly-2021-07-15-6c... 55 7/15/2021
3.0.0-nightly-2021-07-03-6c... 199 7/3/2021
3.0.0-nightly-2021-06-26-6c... 86 6/26/2021
3.0.0-nightly-2021-06-05-6c... 120 6/5/2021
3.0.0-nightly-2021-05-21-7b... 73 5/21/2021
3.0.0-nightly-2021-05-20-7b... 94 5/20/2021
3.0.0-nightly-2021-05-14-09... 65 5/14/2021
3.0.0-nightly-2021-05-10-09... 75 5/10/2021
3.0.0-nightly-2021-05-02-ec... 123 5/2/2021
3.0.0-nightly-2021-04-30-ec... 59 4/30/2021
3.0.0-nightly-2021-04-22-ec... 73 4/22/2021
3.0.0-nightly-2021-04-17-ec... 118 4/17/2021
3.0.0-nightly-2021-04-14-ec... 67 4/14/2021
3.0.0-nightly-2021-04-03-ec... 124 4/3/2021
3.0.0-nightly-2021-01-17-ec... 101 1/17/2021
3.0.0-nightly-2021-01-14-94... 124 1/14/2021
3.0.0-nightly-2021-01-09-fb... 131 1/9/2021
3.0.0-nightly-2020-12-12-fb... 112 12/12/2020
3.0.0-nightly-2020-11-12-83... 139 11/12/2020
3.0.0-nightly-2020-11-06-70... 218 11/6/2020
3.0.0-nightly-2020-11-01-70... 211 11/1/2020
3.0.0-nightly-2020-10-08-de... 253 10/8/2020
3.0.0-nightly-2020-10-03-de... 137 10/3/2020
3.0.0-nightly-2020-10-02-de... 166 10/2/2020
3.0.0-nightly-2020-09-19-de... 150 9/19/2020
3.0.0-nightly-2020-09-16-de... 227 9/16/2020
3.0.0-nightly-2020-09-15-de... 214 9/15/2020
3.0.0-nightly-2020-09-02-2a... 217 9/2/2020
3.0.0-nightly-2020-09-01-ce... 186 9/1/2020
3.0.0-nightly-2020-08-27-15... 258 8/27/2020