jinada/README.md

Liquipedia Competitive Dota 2 wrapper

# Jinada

[![](https://img.shields.io/npm/v/jinada)](https://www.npmjs.com/package/jinada)
[![CodeFactor](https://www.codefactor.io/repository/github/sinkaroid/jinada/badge)](https://www.codefactor.io/repository/github/sinkaroid/jinada)  

## Liquipedia Dota
Unofficial wrapper for Liquipedia Dota.  
This wrapper isn't completed yet but rn you can competitive interaction with:
- Get Latest roster transfer
- Get Ongoing tourney
- Get Upcoming tourney
- Get Completed tourney
- Get Dota of the Days fact.


## Installation 

```
npm i jinada
```

## Example
```js
const Liquipedia = require('jinada');
const jinada = new Liquipedia.Client();

jinada.getRoster().then((data) => {
    console.log(data);
});
```

Returns latest player transfer:

```
[
  {
    date: '2021-06-21',
    player_list: [ '5up', 'empyreaN' ],
    old_team: [],
    new_team: [ 'simply TOOBASED' ]
  },
  {
    date: '2021-06-21',
    player_list: [ 'Jubei' ],
    old_team: [],
    new_team: []
  },
  {
    date: '2021-06-21',
    player_list: [ 'Mushi' ],
    old_team: [],
    new_team: [ 'TNC Predator' ]
  },
  {
    date: '2021-06-19',
    player_list: [ 'Lolingblue' ],
    old_team: [],
    new_team: [ 'Interitus' ]
  },
  {
    date: '2021-06-19',
    player_list: [ 'AMINN', 'DFlash', 'fcr', 'H1j4ck', 'Rayuur' ],
    old_team: [],
    new_team: [ 'Interitus' ]
  },
  {
    date: '2021-06-19',
    player_list: [ 'Rap Rap' ],
    old_team: [],
    new_team: [ 'Team Veteran' ]
  },
  {
    date: '2021-06-18',
    player_list: [ 'MyPro' ],
    old_team: [],
    new_team: [ 'Motivate.Viper Gaming' ]
  },
  {
    date: '2021-06-16',
    player_list: [ 'ppd' ],
    old_team: [],
    new_team: []
  },
  {
    date: '2021-06-15',
    player_list: [ 'Heaven' ],
    old_team: [],
    new_team: [ 'Nemiga Gaming' ]
  },
  {
    date: '2021-06-15',
    player_list: [ 'Raykill' ],
    old_team: [],
    new_team: [ 'Latam Defenders' ]
  },
  {
    date: '2021-06-15',
    player_list: [ 'Aretes', 'BlackSoul' ],
    old_team: [ 'Incubus Club' ],
    new_team: [ 'Latam Defenders' ]
  },
  {
    date: '2021-06-15',
    player_list: [ 'Angel Prince' ],
    old_team: [],
    new_team: [ 'Latam Defenders' ]
  },
  {
    date: '2021-06-15',
    player_list: [ 'Sueño' ],
    old_team: [],
    new_team: []
  },
  {
    date: '2021-06-15',
    player_list: [ 'agressive child' ],
    old_team: [],
    new_team: [ 'Spider Pigzs' ]
  },
  {
    date: '2021-06-15',
    player_list: [ 'dnz', 'Funn1k', 'LeBronDota', 'No!ob' ],
    old_team: [],
    new_team: [ 'Spider Pigzs' ]
  },
  {
    date: '2021-06-15',
    player_list: [ 'RdO' ],
    old_team: [],
    new_team: []
  },
  {
    date: '2021-06-15',
    player_list: [ 'SumaiL' ],
    old_team: [],
    new_team: [ 'OG' ]
  },
  {
    date: '2021-06-14',
    player_list: [ 'eine' ],
    old_team: [ 'Gambit-2' ],
    new_team: [ 'AS Monaco Gambit' ]
  },
  {
    date: '2021-06-14',
    player_list: [ 'ana' ],
    old_team: [ 'OG' ],
    new_team: []
  },
  {
    date: '2021-06-14',
    player_list: [ 'BoraNija' ],
    old_team: [],
    new_team: [ 'Hellbear Smashers' ]
  },
  {
    date: '2021-06-14',
    player_list: [ 'Enryu' ],
    old_team: [],
    new_team: [ 'OB Esports x Neon' ]
  },
  {
    date: '2021-06-14',
    player_list: [ 'Moon' ],
    old_team: [ 'Fnatic' ],
    new_team: [ 'Team SMG' ]
  },
  {
    date: '2021-06-14',
    player_list: [ 'Stormstormer' ],
    old_team: [],
    new_team: []
  },
  {
    date: '2021-06-14',
    player_list: [ 'pieliedie' ],
    old_team: [],
    new_team: [ 'Team Bald Reborn' ]
  },
  {
    date: '2021-06-14',
    player_list: [ '5up' ],
    old_team: [],
    new_team: []
  },
  {
    date: '2021-06-13',
    player_list: [ 'PlayHard' ],
    old_team: [],
    new_team: []
  },
  {
    date: '2021-06-13',
    player_list: [ 'Mice' ],
    old_team: [],
    new_team: []
  },
  {
    date: '2021-06-12',
    player_list: [ 'Fear' ],
    old_team: [],
    new_team: [ 'Thunder Predator' ]
  },
  {
    date: '2021-06-11',
    player_list: [ 'DoT' ],
    old_team: [],
    new_team: [ 'UD Vessuwan' ]
  },
  {
    date: '2021-06-11',
    player_list: [ 'JG', 'Ken', 'LuziFy', 'Rupido', 'Teehee' ],
    old_team: [],
    new_team: [ 'UD Vessuwan' ]
  }
]


```

## Documentation

### getRoster()

Returns latest transfer object.

```js
jinada.getRoster().then((data) => {
    console.log(data);
});
```

### getUpcomingtourney()

Returns Upcoming tourney.

```js
jinada.getUpcomingtourney().then((data) => {
    console.log(data);
});
```

### getOngoingtourney()

Returns Ongoing tourney.

```js
jinada.getOngoingtourney().then((data) => {
    console.log(data);
});
```

### getCompletedtourney()

Returns Completed/Ended tourney.

```js
jinada.getCompletedtourney().then((data) => {
    console.log(data);
});
```

### getDOTD()

Returns Dota of the Day (related day fact).

```js
jinada.getDOTD().then((data) => {
    console.log(data);
});
```

## Todo
-   [x] Transfer
-   [x] Tournaments
-   [ ] Player
-   [ ] Teams
-   [ ] Stats
-   [ ] Patches


## Legal

This tool can be freely copied, modified, altered, distributed without any attribution whatsoever. However, if you feel like this tool deserves an attribution, mention it. It won't hurt anybody :)

Please, read the [license terms](LICENSE). Don't worry, it can be read in less than 30 seconds, unless you have some sort of reading disability - in that case, I'm wondering why you're still reading this text. Really. Stop. Please. I mean, seriously. Why are you still reading?

## Third-party app
Definitely this wrapper only used for my own personal microservice, but yeah i make this public now
- [Telegram:aiogram](https://telegram.me/Scathachbot)
- [Discord:djsl](https://discord.bots.gg/bots/724047481561809007)


## Acknowledgements

Since this tool includes some contributions, and I'm not an asshole, I'll publically thank the following users for their help:

- [Liquipedia/dota2](https://liquipedia.net/dota2) :: actionable data
- [@annam](https://github.com/namdevel) :: tags handler