UNPKG

esijs

Version:
623 lines (412 loc) 13 kB
<!-- Generated by documentation.js. Update this documentation by updating the source code. --> ### Table of Contents - [corporationHistory][1] - [Parameters][2] - [icons][3] - [Parameters][4] - [info][5] - [Parameters][6] - [npcCorps][7] - [blueprints][8] - [Parameters][9] - [secureContainerLogs][10] - [Parameters][11] - [divisions][12] - [Parameters][13] - [facilities][14] - [Parameters][15] - [medals][16] - [medals][17] - [Parameters][18] - [issued][19] - [Parameters][20] - [members][21] - [members][22] - [Parameters][23] - [limit][24] - [Parameters][25] - [titles][26] - [Parameters][27] - [tracking][28] - [Parameters][29] - [roles][30] - [roles][31] - [Parameters][32] - [history][33] - [Parameters][34] - [shareholders][35] - [Parameters][36] - [standings][37] - [Parameters][38] - [starbases][39] - [starbases][40] - [Parameters][41] - [info][42] - [Parameters][43] - [titles][44] - [Parameters][45] - [structures][46] - [Parameters][47] - [bookmarks][48] - [bookmarks][49] - [Parameters][50] - [folders][51] - [Parameters][52] - [contacts][53] - [contacts][54] - [Parameters][55] - [labels][56] - [Parameters][57] - [contracts][58] - [contracts][59] - [Parameters][60] - [bids][61] - [Parameters][62] - [items][63] - [Parameters][64] - [industry][65] - [extractions][66] - [Parameters][67] - [observers][68] - [Parameters][69] - [observerInfo][70] - [Parameters][71] - [jobs][72] - [Parameters][73] - [killmails][74] - [recent][75] - [Parameters][76] - [market][77] - [orders][78] - [Parameters][79] - [orderHistory][80] - [Parameters][81] - [pi][82] - [customsOffices][83] - [Parameters][84] - [wallets][85] - [balance][86] - [Parameters][87] - [journal][88] - [Parameters][89] - [transactions][90] - [Parameters][91] ## corporationHistory Get a list of all the aliances a corporation has been a member of. ### Parameters - `corporationID` {number} The corporation to get the corporation history of. Returns **[Promise][92]<[Array][93]<[number][94]>>** A array of corporation IDs. ## icons Get the icon urls for a corporation. ### Parameters - `corporationID` {number} The corporation ID to get the icon of. Returns **[Promise][92]<[object][95]>** Links to the different sizes of the corporation icon. ## info Get public information about a corporation. ### Parameters - `corporationID` {number} The corporation ID to get info from. Returns **[Promise][92]<[object][95]>** Public info on the corporation. ## npcCorps Get a list of NPC corporations. Returns **[Promise][92]<[Array][93]<[number][94]>>** A array of all NPC corporations. ## blueprints Get corporation blueprints. ### Parameters - `corporationID` **[number][94]**&#x20; - `page` **[number][94]** Which page of results to return. Defaults to 1 (optional, default `1`) Returns **any** a list of blueprints the corporation owns. ## secureContainerLogs Get all corporation ALSC logs. ### Parameters - `corporationID` **[number][94]**&#x20; - `page` **[number][94]** Which page of results to return. Defaults to 1 (optional, default `1`) Returns **any** logs recorded in the past seven days from all audit log secure containers (ALSC) owned by a given corporation. ## divisions Get corporation divisions. ### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** corporation hangar and wallet division names, only show if a division is not using the default name ## facilities Get corporation facilities. ### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** a corporation’s facilities. ## medals ### medals Get corporation medals. #### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** a corporation’s medals. ### issued Get corporation issued medals. #### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** medals issued by a corporation. ## members ### members Get corporation members. #### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** the current member list of a corporation, the token’s character need to be a member of the corporation. ### limit Get corporation member limit. #### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** a corporation’s member limit, not including CEO himself ### titles Get corporation's members' titles. #### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** a corporation’s members’ titles. ### tracking Track corporation members. #### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** additional information about a corporation’s members which helps tracking their activities ## roles ### roles Get corporation member roles. #### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** the roles of all members if the character has the personnel manager role or any grantable role. ### history Get corporation member roles history. #### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** how roles have changed for a coporation’s members, up to a month ## shareholders Get corporation shareholders. ### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** the current shareholders of a corporation. ## standings Get corporation standings. ### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** corporation standings from agents, NPC corporations, and factions. ## starbases ### starbases Get corporation starbases (POSes). #### Parameters - `corporationID` **[number][94]**&#x20; - `page` (optional, default `1`) Returns **any** list of corporation starbases (POSes). ### info Get starbase (POS) detail. #### Parameters - `corporationID` **[number][94]**&#x20; - `starbaseID` **[number][94]**&#x20; - `systemID` **[number][94]** The solar system this starbase (POS) is located in. ## titles Get corporation titles. ### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** a corporation’s titles. ## structures Get corporation structures. ### Parameters - `corporationID` **[number][94]**&#x20; - `page` **[number][94]** (optional, default `1`) Returns **any** a list of corporation structures. This route’s version includes the changes to structures detailed in this blog: [https://www.eveonline.com/article/upwell-2.0-structures-changes-coming-on-february-13th][96] ## bookmarks ### bookmarks List corporation bookmarks #### Parameters - `corporationID` **[number][94]**&#x20; Returns **[Promise][92]<[object][95]>** A list of your corporation’s personal bookmarks. ### folders List corporation bookmark folders #### Parameters - `corporationID` **[number][94]**&#x20; Returns **[Promise][92]<[object][95]>** A list of your corporation’s personal bookmark folders. ## contacts ### contacts Get corporation contacts. #### Parameters - `corporationID` **[number][94]**&#x20; Returns **[Promise][92]<[object][95]>**&#x20; ### labels Get corporation contact labels #### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** esi-corporations.read_contacts.v1 ## contracts ### contracts Get corporation contracts. #### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** contracts available to a corporation, only if the corporation is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is "in_progress". ### bids Get corporation contract bids. #### Parameters - `corporationID` **[number][94]**&#x20; - `contractID` **[number][94]**&#x20; Returns **any** bids on a particular auction contract. ### items Get corporation contract items. #### Parameters - `corporationID` **[number][94]**&#x20; - `contractID` **[number][94]**&#x20; Returns **any** items of a particular contract. ## industry ### extractions Moon extraction timers #### Parameters - `corporationID` **[number][94]**&#x20; - `page` **[number][94]** The page of results to return. (optional, default `1`) Returns **any** Extraction timers for all moon chunks being extracted by refineries belonging to a corporation. ### observers Corporation mining observers. #### Parameters - `corporationID` **[number][94]**&#x20; - `page` **[number][94]** The page of results to return. (optional, default `1`) Returns **any** Paginated list of all entities capable of observing and recording mining for a corporation ### observerInfo Observed corporation mining #### Parameters - `corporationID` **[number][94]**&#x20; - `observerID` **[number][94]**&#x20; - `page` **[number][94]** The page of results to return. (optional, default `1`) Returns **any** Paginated record of all mining seen by an observer. ### jobs List corporation industry jobs #### Parameters - `corporationID` **[number][94]**&#x20; - `page` **[number][94]** The page of results to return. (optional, default `1`) Returns **any** industry jobs run by a corporation ## killmails ### recent Get a corporation's recent kills and losses. #### Parameters - `corporationID` **[number][94]**&#x20; - `page` **[number][94]** The page of results to return. (optional, default `1`) Returns **any** a list of a corporation’s kills and losses going back 90 days. ## market ### orders List open orders from a corporation. #### Parameters - `corporationID` **[number][94]**&#x20; ### orderHistory List historical orders by a corporation. #### Parameters - `corporationID` **[number][94]**&#x20; ## pi ### customsOffices List corporation customs offices. #### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** customs offices owned by a corporation. ## wallets ### balance Get a corporation's wallet balance. #### Parameters - `corporationID` **[number][94]**&#x20; Returns **any** a corporation’s wallets balance. ### journal Get corporation wallet journal. #### Parameters - `corporationID` **[number][94]**&#x20; - `divisionID` **[number][94]** The division to get data from. Returns **any** the given corporation’s wallet journal going 30 days back. ### transactions Get wallet transactions. #### Parameters - `corporationID` **[number][94]**&#x20; - `divisionID` **[number][94]** The division to get data from. Returns **any** wallet transactions of a corporation. [1]: #corporationhistory [2]: #parameters [3]: #icons [4]: #parameters-1 [5]: #info [6]: #parameters-2 [7]: #npccorps [8]: #blueprints [9]: #parameters-3 [10]: #securecontainerlogs [11]: #parameters-4 [12]: #divisions [13]: #parameters-5 [14]: #facilities [15]: #parameters-6 [16]: #medals [17]: #medals-1 [18]: #parameters-7 [19]: #issued [20]: #parameters-8 [21]: #members [22]: #members-1 [23]: #parameters-9 [24]: #limit [25]: #parameters-10 [26]: #titles [27]: #parameters-11 [28]: #tracking [29]: #parameters-12 [30]: #roles [31]: #roles-1 [32]: #parameters-13 [33]: #history [34]: #parameters-14 [35]: #shareholders [36]: #parameters-15 [37]: #standings [38]: #parameters-16 [39]: #starbases [40]: #starbases-1 [41]: #parameters-17 [42]: #info-1 [43]: #parameters-18 [44]: #titles-1 [45]: #parameters-19 [46]: #structures [47]: #parameters-20 [48]: #bookmarks [49]: #bookmarks-1 [50]: #parameters-21 [51]: #folders [52]: #parameters-22 [53]: #contacts [54]: #contacts-1 [55]: #parameters-23 [56]: #labels [57]: #parameters-24 [58]: #contracts [59]: #contracts-1 [60]: #parameters-25 [61]: #bids [62]: #parameters-26 [63]: #items [64]: #parameters-27 [65]: #industry [66]: #extractions [67]: #parameters-28 [68]: #observers [69]: #parameters-29 [70]: #observerinfo [71]: #parameters-30 [72]: #jobs [73]: #parameters-31 [74]: #killmails [75]: #recent [76]: #parameters-32 [77]: #market [78]: #orders [79]: #parameters-33 [80]: #orderhistory [81]: #parameters-34 [82]: #pi [83]: #customsoffices [84]: #parameters-35 [85]: #wallets [86]: #balance [87]: #parameters-36 [88]: #journal [89]: #parameters-37 [90]: #transactions [91]: #parameters-38 [92]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise [93]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array [94]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number [95]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object [96]: https://www.eveonline.com/article/upwell-2.0-structures-changes-coming-on-february-13th