Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/weeco/wrap-royale-core
A promise based, minimalist wrapper for the official Clash Royale API (not released yet) written in TypeScript.
https://github.com/weeco/wrap-royale-core
api api-wrapper clash nodejs royale typescript
Last synced: about 14 hours ago
JSON representation
A promise based, minimalist wrapper for the official Clash Royale API (not released yet) written in TypeScript.
- Host: GitHub
- URL: https://github.com/weeco/wrap-royale-core
- Owner: weeco
- License: mit
- Created: 2018-03-12T01:41:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-27T15:58:58.000Z (almost 5 years ago)
- Last Synced: 2024-03-24T02:43:56.359Z (6 months ago)
- Topics: api, api-wrapper, clash, nodejs, royale, typescript
- Language: TypeScript
- Homepage:
- Size: 271 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wrap Royale Core
[](https://discord.gg/YBAE3JX)
[](https://badge.fury.io/js/wrap-royale-core)
[](https://travis-ci.org/weeco/wrap-royale-core)
[](https://github.com/weeco/wrap-royale-core/blob/master/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](https://github.com/weeco/wrap-royale) which utilizes this library.
Official Clash Royale API documentation: https://developer.clashroyale.com
### Features
- [x] Lightweight, promise based wrapper functions for API requests.
- [x] Types for all returned JSON data, which makes working with it very handy due to intellisense (see: https://i.imgur.com/xzP1AHC.png).
- [x] Normalizes player tags, no matter if you pass `#2OPP`, `20pp` or `#20pp` the request will succeed.
- [x] Failed requests (wrong https status code in response or timeout exceeded) throw an exception
- [x] All API endpoints and parameters are covered.
## Getting started
### Prerequisites
- [Node.js 8.0+](http://nodejs.org)
- Token for the official Clash Royale API (register here and create a token for your IP address https://developer.clashroyale.com)
### Installation
`$ npm install --save wrap-royale-core`
_**Note:** Typescript definitions are included, there is no need for installing types from the Definetely Typed Repo._
### Basic usage
Typescript (2.0+):
```typescript
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 {
try {
const cards: IApiCards = await api.cards();
console.log(cards);
} catch (e) {
console.log(e);
}
}
getAllCards();
```
Javascript (ES6+):
```javascript
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);
})
```
## Class CRApi
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.
### Instantion
When creating a CRApi instance you can pass the following options:
```typescript
/**
* 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;
}
```
### Available endpoints
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\ |
| `locations(limit?: number, after?: string, before?: string)` | Promise\ |
| `locationById(locationId: number)` | Promise\ |
| `clanWarLeaderboard(locationId: string, limit?: number, after?: string, before?: string)`| Promise\ |
| `playerLeaderboard(locationId: string, limit?: number, after?: string, before?: string)` | Promise\ |
| `clanLeaderboard(locationId: string, limit?: number, after?: string, before?: string)` | Promise\ |
| `playerProfile(playerTag: string)` | Promise\ |
| `playersUpcomingChests(playerTag: string)` | Promise\ |
| `playersBattleLogs(playerTag: string)` | Promise\ |
| `clanProfile(clanTag: string)` | Promise\ |
| `currentClanWarInfo(clanTag: string)` | Promise\ |
| `clanWarLog(clanTag: string, locationId: string, limit?: number, after?: string, before?: string)`| Promise\ |