More actions
Provided guidance on ID ranges and how to figure out where to use them. |
m Link maintenance. Comment out dead link. |
||
| Line 1: | Line 1: | ||
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> The data returned by ESI is in the JSON format. | 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>Dev insights blog: [https://developers.eveonline.com/blog/article/important-information-on-the-future-of-the-eve-api Important Information on the Future of the EVE API] (2018-01-03)</ref> The data returned by ESI is in the JSON format. | ||
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 | 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 [[Managing corporation members#List of roles|corporate role]], their corporation. | ||
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]]. | 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 | As a reminder to developers, it is expressly forbidden for developers of third party applications to use them for ill intent<ref>Dev insights blog: [https://developers.eveonline.com/blog/reminder-to-developers-no-scamming Reminder to Developers: No Scamming] (2016-07-04)</ref><ref>Developer documentation: [https://developers.eveonline.com/docs/resources/license License]</ref> | ||
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. Besides [[EVE SSO]], the [[Static Data Export]] and [[Image Server]] might also be useful. | 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. Besides [[EVE SSO]], the [[Static Data Export]] and [[Image Server]] might also be useful. | ||
== ESI Endpoints == | == ESI Endpoints == | ||
ESI provides 195 endpoints, 76 of which related to public data and need no character or client authentication, and 119 of which are authenticated as they relate to privileged information about specific characters or corporations<ref>https://yurix.ch/blog/esi-endpoint-stats.html</ref>. | As of March 2025 ESI provides 195 endpoints, 76 of which related to public data and need no character or client authentication, and 119 of which are authenticated as they relate to privileged information about specific characters or corporations<ref>Yurix: [https://yurix.ch/blog/esi-endpoint-stats.html ESI endpoint counts]</ref>. | ||
The general categories these endpoints fall under are: | The general categories these endpoints fall under are: | ||
| Line 78: | Line 78: | ||
== Examples == | == Examples == | ||
To get a list of all alliances in EVE, the <code> | To get a list of all alliances in EVE, the <code>alliances</code> endpoint can be used. It lists the alliance ID of all alliances. Since it is a public endpoint, it is even possible to a look at it in the browser, although the data comes is in machine-readable JSON: https://esi.evetech.net/alliances | ||
Some endpoints also support parameter in the URL. For example the type endpoint <code> | Some endpoints also support parameter in the URL. For example the type endpoint <code>universe/types/{type_id}/</code> returns information about a type ID. The rifter has type ID 587. To look up information like its description, the <code>{type_id}</code> part in the URL is replaced with the type ID. The full URL would then be https://esi.evetech.net/latest/universe/types/587/ https://esi.evetech.net/universe/types/587 | ||
If possible, CCP requests that users add a descriptive user agent to any ESI request, including a contact email, so that they can be contacted instead of being banned for e.g. causing too much load on the ESI servers. <ref>https://developers.eveonline.com/docs/services/esi/#user- | |||
If possible, CCP requests that users add a descriptive user agent to any ESI request, including a contact email, so that they can be contacted instead of being banned for e.g. causing too much load on the ESI servers. <ref>Developer documentation [https://developers.eveonline.com/docs/services/esi/best-practices/#user-agents Best Practices for ESI > User Agents] (</ref> | |||
== Tips & Tricks == | == Tips & Tricks == | ||
Most ESI endpoints don't have rate-limits, but are error-limited instead, meaning an ESI application is blocked if it makes too many erroneous requests. However, there are two notable exceptions: The <code> | Most ESI endpoints don't have rate-limits, but are error-limited instead, meaning an ESI application is blocked if it makes too many erroneous requests. However, there are two notable exceptions: The <code>characters/{character_id}/corporationhistory/</code> and the <code>markets/{region_id}/history/</code> endpoints have rate limits of 300 requests per IP per minute.<ref>EVE Forums: [https://forums.eveonline.com/t/resolved-esi-characters-corporation-history/391132/27 Resolved - ESI Characters Corporation History] (2023-08-25)</ref><ref>Dev blog: [https://www.eveonline.com/news/view/eve-evolved-the-future-of-eves-api EVE Evolved: The Future of EVE’s API] (2025-02-27)</ref> This rate limit is unfortunately not documented in the ESI docs. | ||
Eve uses a lot of 'ID's, that are unique for things. Ships, players, corporations, systems all have unique IDs. Most IDs are arranged in 'Ranges' as well. Comparing IDs against these ranges to find out what type of ID it is. https://developers.eveonline.com/docs/guides/id-ranges/ has these ranges listed out. Figuring out what an ID is can answer many questions of what ESI to find out what it is. There are two very fast ways to find Names for IDs as well. Linking a thing in chat, then hit enter, then right click, and copy. This will put the URL code in the clipboard. Alternately, go to a site like https://zkillboard.com/ and the ID will be at the end. Ex: https://zkillboard.com/ship/22460 the Eris id is 22460. | Eve uses a lot of 'ID's, that are unique for things. Ships, players, corporations, systems all have unique IDs. Most IDs are arranged in 'Ranges' as well. Comparing IDs against these ranges to find out what type of ID it is. https://developers.eveonline.com/docs/guides/id-ranges/ has these ranges listed out. Figuring out what an ID is can answer many questions of what ESI to find out what it is. There are two very fast ways to find Names for IDs as well. Linking a thing in chat, then hit enter, then right click, and copy. This will put the URL code in the clipboard. Alternately, go to a site like https://zkillboard.com/ and the ID will be at the end. Ex: https://zkillboard.com/ship/22460 the Eris id is 22460. See also [[How to get ID]] | ||
== Resources For Developers == | == Resources For Developers == | ||
| Line 104: | Line 105: | ||
| https://community.eveonline.com/news/dev-blogs/introducing-esi/ || Original Announcement introducing ESI. | | 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. | | <s>https://github.com/devfleet/awesome-eve#developer-tools-resources-and-apis</s> || ARCHIVED (2025-06-20) Community-maintained list of resources and tools to work with ESI. | ||
|- | |||
| https://developers.eveonline.com/docs/community/ || Community tools and Services | |||
|- | |- | ||
| 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://forums.eveonline.com/t/3-3-0-gesi-google-sheets-esi-library/13406 || GESI - A library for working with ESI in Google Sheets | ||
|- | <!-- dead link |- | ||
| https://developers.eveonline.com/blog/ | | 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://www.fuzzwork.co.uk/2017/03/14/using-esi-google-sheets/ || A different guide on working with GESI (see above) | ||
| Line 117: | Line 120: | ||
== Patch History == | == Patch History == | ||
{{expansion past| | {{expansion past| | ||
'''03.02.25''' - [https://developers.eveonline.com/blog/deprecation-and-impending-removal-of-esi-opportunities-and-esi-bookmarks | '''03.02.25''' - Dev insights blog: [https://developers.eveonline.com/blog/deprecation-and-impending-removal-of-esi-opportunities-and-esi-bookmarks Deprecation and impending removal of esi-opportunities and esi-bookmarks] | ||
* The bookmark endpoints has been removed after being disabled for more than 5 years<ref>https://developers.eveonline.com/blog/article/temporary-blackout-of-esi-bookmarks</ref>. | * The bookmark endpoints has been removed after being disabled for more than 5 years<ref>Dev insights blog: [https://developers.eveonline.com/blog/article/temporary-blackout-of-esi-bookmarks Temporary blackout of ESI-bookmarks] (2019-11-24)</ref>. | ||
* The opportunities endpoints have been removed. | * The opportunities endpoints have been removed. | ||
}} | }} | ||
| Line 124: | Line 127: | ||
== References == | == References == | ||
<references /> | <references /> | ||
[[Category:Applications]] | [[Category:Applications]] | ||