esijs
Version:
A simple module for ESI.
91 lines (58 loc) • 2.31 kB
Markdown
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
### Table of Contents
- [leaderboards][1]
- [characters][2]
- [corps][3]
- [leaderboard][4]
- [stats][5]
- [stats][6]
- [characterStats][7]
- [Parameters][8]
- [corporationStats][9]
- [Parameters][10]
- [systems][11]
- [wars][12]
## leaderboards
### characters
Top 100 leaderboard of pilots for kills and victory points separated by total, last week and yesterday
Returns **[Promise][13]<[object][14]>** Character leaderboard of kills and victory points within faction warfare.
### corps
Returns **[Promise][13]<[object][14]>** Corporation leaderboard of kills and victory points within faction warfare.
### leaderboard
Top 4 leaderboard of factions for kills and victory points separated by total, last week and yesterday.
Returns **[Promise][13]<[object][14]>** All-time leaderboard of kills and victory points within faction warfare.
## stats
### stats
Statistical overviews of factions involved in faction warfare
Returns **[Promise][13]<[object][14]>** Per faction breakdown of faction warfare statistics.
### characterStats
Overview of a character involved in faction warfare.
#### Parameters
- `characterID` **[number][15]** 
Returns **any** Statistical overview of a character involved in faction warfare.
### corporationStats
Overview of a corporation involved in faction warfare.
#### Parameters
- `corporationID` **[number][15]** 
Returns **any** Statistics about a corporation involved in faction warfare.
## systems
An overview of the current ownership of faction warfare solar systems.
Returns **[Promise][13]<[object][14]>** 
## wars
Data about which NPC factions are at war.
Returns **[Promise][13]<[object][14]>** 
[1]: #leaderboards
[2]: #characters
[3]: #corps
[4]: #leaderboard
[5]: #stats
[6]: #stats-1
[7]: #characterstats
[8]: #parameters
[9]: #corporationstats
[10]: #parameters-1
[11]: #systems
[12]: #wars
[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
[15]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number