EVE Swagger Interface - EVE University Wiki (2024)

This page should be updated due to game changes.
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:

CategoryPublicAuthDescription
Alliances4General information about Alliances and their member corporations
Assets6Inventory details for characters and corporations
Bookmarks4All of a character or corporation's[4] bookmarks and bookmark folders
Calendar4Read and respond to a character's calendar events
Character411Information relating specifically to a character, where it does not fall under any other category.
Clones2Information on a character's clones and their active implants
Contacts9Read Contacts lists for characters, corporations and alliances, and edit them for characters.
Contracts36List public, character and corporate contracts, bids placed on them, and items contained in them.
Corporation418Information relating specifically to a corporation, where it does not fall under any other category.
Dogma5Information regarding Dogma, EVE's system for attributes on items and entities.
Faction Warfare62Public statistics on faction warfare, systems, leaderboards, and a character's statistics.
Fittings3View, create or delete a character's in-game saved fittings.
Fleets14Provides endpoints for a complete breakdown of a fleet's composition, and allows managing it externally.
Incursions1A list of currently active Incursions and some basic info about them
Industry26System Cost Indices, Industry facilities, and all information about a character's active industry jobs.
Insurance1A list of insurance prices for all classes of ships.
Killmails12Retrieve killmails relating to a character, or all details on a killmail for which you have the appropriate information.
Location3View whether a character is online, what they're flying, and where they are located.
Loyalty11List offers available from a provided NPC Corporation's LP Store, and a character's available LP.
Mail9All actions related to viewing, sending and deleting in-game mail for a character.
Market65Market orders and histories, as well as a character or corporation's specific orders.
Opportunities41A list of tasks associated with the New Player Experience / Tutorial, and whether a character has completed them.
Planetary Industry13Details on a character's planetary colonies and their layouts, as well as public information on PI Schematics.
Routes1Use the game's algorithms to calculate a route between two systems
Search11Perform a search on the provided string against the chosen categories. If for a character, will also search private things the character can see.
Skills3Information on a character's attributes, skills and skill training queue.
Sovereignty3Lists of sovereignty campaigns, systems and structures.
Status1Status of the game: Whether it's running, what version, and how many players are logged in.
Universe30Just about all general public, static data in the game.
User Interface5Allows opening certain UI windows for a character if they are logged in to the game.
Wallet6Character and Corporation wallet balances and transactions.
Wars3Details 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-issuesOfficial Git Repository for tracking issues and requests for ESI.
https://github.com/esi/esi-issues/issues/1103A 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-apisCommunity-maintained list of resources and tools to work with ESI.
https://forums.eveonline.com/t/3-3-0-gesi-google-sheets-esi-library/13406GESI - A library for working with ESI in Google Sheets
https://developers.eveonline.com/blog/article/using-esi-with-google-sheetsA 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_QueryInformation on working with ESI in MS Excel with Power Query (archived webpage)

References

EVE Swagger Interface - EVE University Wiki (2024)
Top Articles
Latest Posts
Article information

Author: Dean Jakubowski Ret

Last Updated:

Views: 6056

Rating: 5 / 5 (70 voted)

Reviews: 85% of readers found this page helpful

Author information

Name: Dean Jakubowski Ret

Birthday: 1996-05-10

Address: Apt. 425 4346 Santiago Islands, Shariside, AK 38830-1874

Phone: +96313309894162

Job: Legacy Sales Designer

Hobby: Baseball, Wood carving, Candle making, Jigsaw puzzles, Lacemaking, Parkour, Drawing

Introduction: My name is Dean Jakubowski Ret, I am a enthusiastic, friendly, homely, handsome, zealous, brainy, elegant person who loves writing and wants to share my knowledge and understanding with you.