Difference between revisions of "EVE Swagger Interface"
From EVE University Wiki
Salartarium (talk | contribs) m (Update date) |
m (Remove links to old API.) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Update|Need more information on the endpoints, and fleshing out some how-to guides}} | {{Update|Need more information on the endpoints, and fleshing out some how-to guides}} | ||
| − | EVE Swagger Interface (ESI) is an API that can be used by [[Third- | + | EVE Swagger Interface (ESI) is an API that can be used by [[Third-party tools|third party applications]] to interact with data from the EVE game servers. It replaces CREST and the XML API which were shut down on May 8th, 2018.<ref>https://developers.eveonline.com/blog/article/important-information-on-the-future-of-the-eve-api</ref> |
ESI has both public-data and authenticated endpoints, the latter of which require a character to log in via [[EVE SSO]] to their character account to gain access to information specific to their character or, provided they have the appropriate corporate roles, their corporation. At present there are 81 public-data and 125 Authenticated endpoints (206 total). | ESI has both public-data and authenticated endpoints, the latter of which require a character to log in via [[EVE SSO]] to their character account to gain access to information specific to their character or, provided they have the appropriate corporate roles, their corporation. At present there are 81 public-data and 125 Authenticated endpoints (206 total). | ||
| − | CCP has indicated that their goal is to completely replace the [[ | + | CCP has indicated that their goal is to completely replace the [[Static Data Export]] (SDE) with ESI, but as of September 2023, there are still many missing features. For example, industry recipes still require the [[Static Data Export|SDE]]. |
As a reminder to developers, it is expressly forbidden for developers of third party applications to use them for ill intent<ref name="scamming">[https://developers.eveonline.com/blog/article/reminder-no-scamming Reminder to Developers: No Scamming]</ref><ref>https://developers.eveonline.com/resource/license-agreement</ref> | As a reminder to developers, it is expressly forbidden for developers of third party applications to use them for ill intent<ref name="scamming">[https://developers.eveonline.com/blog/article/reminder-no-scamming Reminder to Developers: No Scamming]</ref><ref>https://developers.eveonline.com/resource/license-agreement</ref> | ||
| Line 10: | Line 10: | ||
ESI and SSO are commonly used together, however they do have independent features and uses as well. For this reason, they have been split into their own articles. See [[EVE SSO]] for information regarding the character authentication (and management thereof) aspect. | ESI and SSO are commonly used together, however they do have independent features and uses as well. For this reason, they have been split into their own articles. See [[EVE SSO]] for information regarding the character authentication (and management thereof) aspect. | ||
| − | ==ESI Endpoints== | + | == ESI Endpoints == |
ESI provides 206 endpoints, 81 of which related to public data and need no character or client authentication, and 135 of which are authenticated as they relate to privileged information about specific characters or corporations. | ESI provides 206 endpoints, 81 of which related to public data and need no character or client authentication, and 135 of which are authenticated as they relate to privileged information about specific characters or corporations. | ||
Latest revision as of 13:58, 29 November 2023
This page should be updated due to game changes.
Reason: Need more information on the endpoints, and fleshing out some how-to guides
Reason: Need more information on the endpoints, and fleshing out some how-to guides
EVE Swagger Interface (ESI) is an API that can be used by third party applications to interact with data from the EVE game servers. It replaces CREST and the XML API which were shut down on May 8th, 2018.[1]
ESI has both public-data and authenticated endpoints, the latter of which require a character to log in via EVE SSO to their character account to gain access to information specific to their character or, provided they have the appropriate corporate roles, their corporation. At present there are 81 public-data and 125 Authenticated endpoints (206 total).
CCP has indicated that their goal is to completely replace the Static Data Export (SDE) with ESI, but as of September 2023, there are still many missing features. For example, industry recipes still require the SDE.
As a reminder to developers, it is expressly forbidden for developers of third party applications to use them for ill intent[2][3]
ESI and SSO are commonly used together, however they do have independent features and uses as well. For this reason, they have been split into their own articles. See EVE SSO for information regarding the character authentication (and management thereof) aspect.
ESI Endpoints
ESI provides 206 endpoints, 81 of which related to public data and need no character or client authentication, and 135 of which are authenticated as they relate to privileged information about specific characters or corporations.
The general categories these endpoints fall under are:
| Category | Public | Auth | Description |
|---|---|---|---|
| Alliances | 4 | General information about Alliances and their member corporations | |
| Assets | 6 | Inventory details for characters and corporations | |
| Bookmarks | 4 | All of a character or | |
| Calendar | 4 | Read and respond to a character's calendar events | |
| Character | 4 | 11 | Information relating specifically to a character, where it does not fall under any other category. |
| Clones | 2 | Information on a character's clones and their active implants | |
| Contacts | 9 | Read Contacts lists for characters, corporations and alliances, and edit them for characters. | |
| Contracts | 3 | 6 | List public, character and corporate contracts, bids placed on them, and items contained in them. |
| Corporation | 4 | 18 | Information relating specifically to a corporation, where it does not fall under any other category. |
| Dogma | 5 | Information regarding Dogma, EVE's system for attributes on items and entities. | |
| Faction Warfare | 6 | 2 | Public statistics on faction warfare, systems, leaderboards, and a character's statistics. |
| Fittings | 3 | View, create or delete a character's in-game saved fittings. | |
| Fleets | 14 | Provides endpoints for a complete breakdown of a fleet's composition, and allows managing it externally. | |
| Incursions | 1 | A list of currently active Incursions and some basic info about them | |
| Industry | 2 | 6 | System Cost Indices, Industry facilities, and all information about a character's active industry jobs. |
| Insurance | 1 | A list of insurance prices for all classes of ships. | |
| Killmails | 1 | 2 | Retrieve killmails relating to a character, or all details on a killmail for which you have the appropriate information. |
| Location | 3 | View whether a character is online, what they're flying, and where they are located. | |
| Loyalty | 1 | 1 | List offers available from a provided NPC Corporation's LP Store, and a character's available LP. |
| 9 | All actions related to viewing, sending and deleting in-game mail for a character. | ||
| Market | 6 | 5 | Market orders and histories, as well as a character or corporation's specific orders. |
| Opportunities | 4 | 1 | A list of tasks associated with the New Player Experience / Tutorial, and whether a character has completed them. |
| Planetary Industry | 1 | 3 | Details on a character's planetary colonies and their layouts, as well as public information on PI Schematics. |
| Routes | 1 | Use the game's algorithms to calculate a route between two systems | |
| Search | 1 | 1 | Perform a search on the provided string against the chosen categories. If for a character, will also search private things the character can see. |
| Skills | 3 | Information on a character's attributes, skills and skill training queue. | |
| Sovereignty | 3 | Lists of sovereignty campaigns, systems and structures. | |
| Status | 1 | Status of the game: Whether it's running, what version, and how many players are logged in. | |
| Universe | 30 | Just about all general public, static data in the game. | |
| User Interface | 5 | Allows opening certain UI windows for a character if they are logged in to the game. | |
| Wallet | 6 | Character and Corporation wallet balances and transactions. | |
| Wars | 3 | Details on all wars that have happened in the game, including their killmails. |
Resources For Developers
There are a number of resources online for developers looking to begin using ESI, many of which also cover SSO for authenticating endpoints.
| https://docs.esi.evetech.net/ | Community-maintained documentation for ESI. |
| https://esi.evetech.net/ui/ | CCP's front-end User Interface for "playing" with ESI and discovering what the various endpoints can do. |
| https://github.com/esi/esi-issues | Official Git Repository for tracking issues and requests for ESI. |
| https://github.com/esi/esi-issues/issues/1103 | A specific issue on the above repository, that compares ESI to the information available in SDE. |
| https://community.eveonline.com/news/dev-blogs/introducing-esi/ | Original Announcement introducing ESI. |
| https://github.com/devfleet/awesome-eve#developer-tools-resources-and-apis | Community-maintained list of resources and tools to work with ESI. |
| https://forums.eveonline.com/t/3-3-0-gesi-google-sheets-esi-library/13406 | GESI - A library for working with ESI in Google Sheets |
| https://developers.eveonline.com/blog/article/using-esi-with-google-sheets | A slightly outdated CCP Dev blog on working with GESI (see above) |
| https://www.fuzzwork.co.uk/2017/03/14/using-esi-google-sheets/ | A different guide on working with GESI (see above) |
| https://web.archive.org/web/20190310221844/https://wiki.zansha.space/index.php/SSO_Authentication_in_Microsoft_Power_Query | Information on working with ESI in MS Excel with Power Query (archived webpage) |
