# resteemo

> RESTeemo API wrapper.

Latest version **2.4.1** (published 2013-09-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install resteemo
pnpm add resteemo
yarn add resteemo
bun add resteemo
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.4.1 |
| Published | 2013-09-30 |
| First published | 2013-05-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Kenan Yildirim |
| Maintainers | kenan |
| Keywords | api, league-of-legends |

## Links

- npm: https://www.npmjs.com/package/resteemo
- Repository: https://github.com/KenanY/node-resteemo
- Issues: https://github.com/KenanY/node-resteemo/issues
- npm.io page: https://npm.io/package/resteemo

## Dependencies (6)

- [request](https://npm.io/package/request.md) ~2.27.0
- [lodash.find](https://npm.io/package/lodash.find.md) ~2.2.0
- [lodash.isnull](https://npm.io/package/lodash.isnull.md) ~2.2.0
- [lodash.isstring](https://npm.io/package/lodash.isstring.md) ~2.2.0
- [lodash.isfunction](https://npm.io/package/lodash.isfunction.md) ~2.2.0
- [lodash.isundefined](https://npm.io/package/lodash.isundefined.md) ~2.2.0

## Recent versions

- 2.4.1 (latest) — 2013-09-30
- 2.4.0 — 2013-09-14
- 2.3.0 — 2013-08-02
- 2.2.0 — 2013-07-19
- 2.1.0 — 2013-06-21
- 2.0.0 — 2013-06-20
- 1.2.1 — 2013-06-04
- 1.2.0 — 2013-05-02
- 1.1.0 — 2013-05-01
- 1.0.0 — 2013-05-01

## README

# node-resteemo

[![Build Status](https://travis-ci.org/KenanY/node-resteemo.png)](https://travis-ci.org/KenanY/node-resteemo)
[![Dependency Status](https://gemnasium.com/KenanY/node-resteemo.png)](https://gemnasium.com/KenanY/node-resteemo)

RESTeemo API wrapper for Node. Powered by Quickfind.

![captain teemo on duty](https://a248.e.akamai.net/camo.github.com/32fb5a8ead7c5cdff5b8003b84b0a7189a05d67c/687474703a2f2f692e696d6775722e636f6d2f654964593746612e706e67)

## Installation

``` bash
$ npm install resteemo
```

## API

As per RESTeemo's Terms and Conditions, you must provide contact details in the
user agent of requests. node-resteemo will not fill in these details for you.

``` javascript
var teemo = require('resteemo')('string with contact info');
```

All functions are asynchronous. The callback is always executed as
`callback(error, response)`, where `response` is an Object unless there was an
error. Refer to RESTeemo's API docs for what each `response` looks like.

### Player requests

Looks up information for String `summoner` on String `platform`.

- `teemo.player(platform, summoner, callback)`
- `teemo.player.ingame(platform, summoner, callback)`
- `teemo.player.recentGames(platform, summoner, callback)`
- `teemo.player.influencePoints(platform, summoner, callback)`
- `teemo.player.runes(platform, summoner, callback)`
- `teemo.player.mastery(platform, summoner, callback)`
- `teemo.player.leagues(platform, summoner, callback)`
- `teemo.player.honor(platform, summoner, callback)`
- `teemo.player.teams(platform, summoner, callback)`

Here, `season` is a Number.

- `teemo.player.rankedStats(platform, summoner, season, callback)`

### Team requests

Looks up information for a team using String `tag` or String `guid` on String
`platform`.

- `teemo.team(platform, tag, callback)`
- `teemo.team.leagues(platform, guid, callback)`

### Platform requests

- `teemo.freeWeek(platform, callback)`

## Supported platforms

Below is a table of the platforms that RESTeemo supports. When polling
the API, the shorthand version of a platform is necessary, but you can pass the
full version to node-resteemo if you'd like and it will internally use the
shorthand version.

<table>
  <tr>
    <th>Short</th>
    <th>Full</th>
  </tr>
  <tr>
    <td>na</td>
    <td>North_America</td>
  </tr>
  <tr>
    <td>br</td>
    <td>Brasil</td>
  </tr>
  <tr>
    <td>ru</td>
    <td>Russia</td>
  </tr>
  <tr>
    <td>euw</td>
    <td>Europe_West</td>
  </tr>
  <tr>
    <td>eun</td>
    <td>Europe_East</td>
  </tr>
  <tr>
    <td>tr</td>
    <td>Turkey</td>
  </tr>
  <tr>
    <td>las</td>
    <td>Latin_America_South</td>
  </tr>
  <tr>
    <td>lan</td>
    <td>Latin_America_North</td>
  </tr>
</table>

## Release notes

### 2.4.1

- Updated lodash.isundefined to 2.2.x
- Updated lodash.isstring to 2.2.x
- Updated lodash.isnull to 2.2.x
- Updated lodash.isfunction to 2.2.x

View previous releases [here](https://github.com/KenanY/node-resteemo/wiki/Changelog).

---
_Source: https://npm.io/package/resteemo · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
