esijs

Version:

A simple module for ESI.

89 lines (59 loc) • 1.96 kB

Markdown

### Table of Contents - [groups][1] - [groupInfo][2] - [Parameters][3] - [groups][4] - [history][5] - [Parameters][6] - [orders][7] - [Parameters][8] - [prices][9] - [types][10] - [Parameters][11] ## groups ### groupInfo Get information on an item group. #### Parameters - `groupID` **[number][12]**  Returns **[Promise][13]<[object][14]>**  ### groups Get a list of item groups. Returns **[Promise][13]<\[[number][12]]>**  ## history Return a list of historical market statistics for the specified type in a region. ### Parameters - `regionID` **[number][12]**  - `typeID` **[number][12]**  Returns **[Promise][13]<[object][14]>**  ## orders Return a list of orders in a region. ### Parameters - `regionID` **[number][12]**  - `typeID` **[number][12]**  - `bOs` **[string][15]** (optional, default `'all'`) - `pageNumber` **[number][12]** (optional, default `1`) ## prices Return a list of prices. Returns **[Promise][13]<[object][14]>**  ## types Return a list of type IDs that have active orders in the region, for efficient market indexing. ### Parameters - `regionID` **[number][12]**  - `pageNumber` **[number][12]** (optional, default `1`) Returns **[Promise][13]<[object][14]>**  [1]: #groups [2]: #groupinfo [3]: #parameters [4]: #groups-1 [5]: #history [6]: #parameters-1 [7]: #orders [8]: #parameters-2 [9]: #prices [10]: #types [11]: #parameters-3 [12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number [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/String