A promise based, minimalist wrapper for the official Clash Royale API (not released yet) written in TypeScript.
MIT License
Wrap royale core is a promise based, minimalist wrapper for the official Clash Royale REST API. It covers all endpoints and parameters, but it barely offers any utility methods. If you are looking for a more feature rich library to interact with the Clash Royale API, take a look at wrap-royale which utilizes this library.
Official Clash Royale API documentation: https://developer.clashroyale.com
#2OPP
, 20pp
or #20pp
the request will succeed.$ npm install --save wrap-royale-core
Note: Typescript definitions are included, there is no need for installing types from the Definetely Typed Repo.
Typescript (2.0+):
import { CRApi, IApiCards } from 'wrap-royale-core';
const baseUri: string = 'https://api.clashroyale.com/v1';
const apiToken: string = 'my-long-jwt';
const api: CRApi = new CRApi(baseUri, apiToken);
async function getAllCards(): Promise<void> {
try {
const cards: IApiCards = await api.cards();
console.log(cards);
} catch (e) {
console.log(e);
}
}
getAllCards();
Javascript (ES6+):
const CRApi = require('wrap-royale-core').CRApi;
const baseUri = 'https://api.clashroyale.com/v1';
const apiToken = 'my-long-jwt';
const api = new CRApi(baseUri, apiToken);
api.cards()
.then((cards) => {
console.log(cards);
})
.catch((err) => {
console.log(err);
})
The class CRApi offers all available endpoints as promise based functions. Each function returns a Promise which resolves to the json response from the API. If the HTTPS response code is not 2xx (for instance 503
which is being used for API maintenance) an exception will be thrown.
When creating a CRApi instance you can pass the following options:
/**
* Initialize all settings.
* @param uri Base url to Clash Royale API e.g. 'https://api.clashroyale.com/v1/'.
* @param token Your API token (JWT as string).
* @param options Additional options for this wrapper.
*/
constructor(uri: string, token: string, options?: IApiOptions);
interface IApiOptions {
/**
* Timeout for awaiting a response until it fails. Defaults to 6000 milliseconds.
*/
timeoutMS?: number;
}
Below you'll find a summary of all available methods. For more details about the parameters or method, take a look at the code which comes along with function documentation.
Route | Returns |
---|---|
cards() |
Promise<IApiCards> |
locations(limit?: number, after?: string, before?: string) |
Promise<IApiLocations> |
locationById(locationId: number) |
Promise<IApiLocation> |
clanWarLeaderboard(locationId: string, limit?: number, after?: string, before?: string) |
Promise<IApiClanWarLeaderboard> |
playerLeaderboard(locationId: string, limit?: number, after?: string, before?: string) |
Promise<IApiPlayerLeaderboard> |
clanLeaderboard(locationId: string, limit?: number, after?: string, before?: string) |
Promise<IApiClanLeaderboard> |
playerProfile(playerTag: string) |
Promise<IApiPlayerProfile> |
playersUpcomingChests(playerTag: string) |
Promise<IApiUpcomingChests> |
playersBattleLogs(playerTag: string) |
Promise<IApiPlayersBattleLogs[]> |
clanProfile(clanTag: string) |
Promise<IApiClanProfile> |
currentClanWarInfo(clanTag: string) |
Promise<ICurrentClanWar> |
clanWarLog(clanTag: string, locationId: string, limit?: number, after?: string, before?: string) |
Promise<IClanWarLog> |