Skip to content

matous-volf/clash-royale-dotnet

Repository files navigation

Clash Royale .NET

An unofficial .NET wrapper for Supercell's Clash Royale API.

Installation

  1. Install the NuGet package.

  2. Add the ClashRoyaleAPI namespace wherever you want to use it:

    using ClashRoyaleAPI;

Usage

After installing, you'll be able to reference the classes and methods.

In order to use the API, you need to create an instance of the ClashRoyale class. In the constructor, pass an API key:

ClashRoyale clashRoyale = new(key:"<your_key>");

Optionally, you can choose to use RoyaleAPI proxy servers with the second parameter:

ClashRoyale clashRoyale = new(key:"<your_key>", useProxyServers:true);

Both of these can be changed later by setting the Key and UseProxyServers properties.

Player information

To get information about a player, use the GetPlayerByTag method:

Player player = clashRoyale.GetPlayerByTag(tag:"#2PRQQVR88");

Although in the official API it is divided into different requests, this information also contains the player's Battle log and upcoming Chests.

Clan information

By Tag

To get information about a particular Clan, use the GetClanByTag method:

Clan clan = clashRoyale.GetClanByTag(tag: "#L2QCY2VC");

Although in the official API it is divided into different requests, this information also contains the Clan's current and previous River races.

By properties

To get information about Clans searched by their properties, use the GetClansBySearch method:

SearchResultClan[] clans = clashRoyale.GetClansBySearch(name: "HMaK", locationID: 57000070, minMembers: 35, maxMembers: 45, minScore: 30000);

Card information

To get information about all Cards, use the GetAllCards method:

Card[] cards = clashRoyale.GetAllCards();

Challenges information

To get information about currently known Challenges, use the GetCurrentChallenges method:

ChallengeChain[] challengeChains = clashRoyale.GetCurrentChallenges();

API coverage

The latest release covers these parts of the official API:

  • players
  • Clans
  • Cards
  • Challenges

These parts are not covered yet:

  • Tournaments
  • locations

Known issues

Below are currently known problems this package has:

  • Players' upcoming Chests don't include Royal Wild Chest. It seems Supercell only grants this information to RoyaleAPI.
  • Challenges returned from the GetCurrentChallenges method have invalid end times. This is caused by a bug in the official API.

Due to the implementation in this package, both of these issues are going to be resolved the moment they get fixed in the official API.

Contact

If you encounter any bug or imperfection, please let me know by submitting an issue.

With questions or anything else, send me an email to matousvolfu@gmail.com.


This material is unofficial and is not endorsed by Supercell. For more information see Supercell's fan content policy.