Navigation
| EVElopedia home |
| Community portal |
| Current events |
| Recent changes |
| Random page |
| Create page |
| Help |
Item Database
| Ammunition & Charges |
| Blueprints |
| Drones |
| Implants & Boosters |
| Manufacture & Research |
| Planetary Infrastructure |
| Ship Equipment |
| Ship Modifications |
| Ships |
| Skills |
| Starbase & Sovereignty Structures |
| Trade Goods |
Tools
EVE API Functions
 |
This article is a stub. You can help Evelopedia by expanding it with more content and relevant information. Other Stub Articles |
Suggest spliting the page Old/New API functionality.
New fuctionality talked about in a devblog at Power to the Player
Contents |
Api functions
Below you will find all the application programming interfaces that are found on EVE API. Each API address is made up of a base URL plus any parameters that need to be sent. For example, the Characters API requires the user ID and API key to be sent, so the general URL for the Character API is https://api.eveonline.com/account/characters.xml.aspx?userID=#####&apiKey=######### This structure is used for all API URLs.
Input arguments
To retrieve some of the data provided by the API, you will need to provide additional arguments, such as character IDs or item IDs, depending on the service. These arguments are supplied in the same way as authentication, through an HTTP POST method. If any of the arguments are invalid, an error will be returned. The arguments required for each API service can be found in the description of each service (found in the menu below).
Quick reference
Account
| API | Description |
| Characters | Retrieves character information for the user ID and API key provided. |
| Status | Returns basic account information such as when the subscription lapses, total play time in minutes, total times logged on and date of account creation. In the case of accounts created with GTC, it will also looks for available offers of time codes. |
| Key Info | Returns the list of characters and the access mask associated to the API keyId and vCode |
Character data
| API | Description |
| Account Balance | The Account Balance API allows you to list the accounts and account balances of a given character. |
| Asset List | The Asset List API is used to access a list of items owned by a character with the location of each item. As it is possible for some items to be located within other items, this API returns the asset list as nested XML. |
| Calendar Event Attendees | Returns a list of all invited attendees for a given event. |
| Character Sheet | The Character Sheet API displays the full character sheet for the character ID provided. The character sheet contains basic character information such as the character's name, race, bloodline and gender, as well as information about their corporation and account balance.
Character attributes and skills that the character has learned are also included in the character sheet. Skills are listed as row in the XML output of the API. |
| Contact List | The Contact List API returns the character's contact list and watch lists (includes agents and respective standings set by the character). |
| Contact Notifications | The Contact Notifications API lists the notifications received about having been added to someone's contact list. |
| Factional Warfare Statics | The Faction Warfare Statistics API displays statistics for characters enlisted in Factional Warfare. The API will return the faction the character is enlisted in, the current rank and the highest rank that the character has attained. The API also returns how many kills and victory points the character obtained the previous day, in the last week and in total. |
| Industry Jobs | The Industry Jobs API lists all industry jobs associated with the given character ID that have a status of “in progress”, “pending” or “completed”. When an industry job's status changes to “delivered”, then the job will drop
off of this list. |
| Kill Log | The Kill Log API lists the 25 most recent kills for a given character ID or the most recent 100 kills in the case of a corporation ID. Location information and the time of kill are also given in the XML output.
Note that there is an optional parameter for this API function called beforeKillID, which allows you to return the most recent kills before the specified killID. |
| Mailing Lists | The Mailing Lists API returns an XML document listing all mailing lists of which the character is currently a member. |
| Mail Bodies | The Mail Bodies API returns the bodies of headers that have already been fetched with the MailMessages call. It will also return a list of missing IDs that could not be accessed, which is the case if you have not called for their headers recently. |
| Mail Messages | The Mail Messages API returns the message headers for mail. |
| Market Orders | The Market Orders API lists all buy and sell orders associated with a given character ID. |
| Medals | The Medals API returns a list of medals that the character has. |
| Notification Texts | Returns the body text of notifications. |
| Notifications | The Notifications API returns the message headers for notifications. The first request will return the latest 200
notifications that were received by the character in the last week. Subsequent requests will return only the new items since the last request. |
| NPC Standings | The NPC Standings API returns the standings towards a character from agents, NPC corporations and factions.
With the Tyrannis expansion, the Standings API has been replaced in favor of the Contact List API. |
| Research | The Research API returns information about the agents with whom the character is doing research. |
| Skill In Training | The Skill in Training API returns the skill that is currently being trained by a specified character. |
| Skill Queue | The Skill Queue API returns an XML document containing the skill queue of the character. |
| Upcoming Calendar Events | Returns a list of all upcomming calendar events for a given character. |
| Wallet Journal | The Wallet Journal API returns a complete record of all wallet activity for a specified character. |
| Wallet Transactions | The Wallet Transactions API gives an overview of marketing transactions only. Basically, this returns a list of what was sold, who bought it, how much tax was paid, etc. An example of the XML is shown below with the columns included for each transaction. |
Corporation Information
| API | Description |
| Account Balance | This API returns an XML formatted dump of the wallets belonging to a corporation as well as their current balance.
Corporate wallet information is only available to Junior Accountants, Accountants, Directors, or CEOs. |
| Asset List | The Asset List API returns all assets owned by the corporation and the location of each. Note that because items can be located within other items, this API returns nested XML. For example, an office owned by the corporation may contain a desk that is also owned by the corporation. In that case, the office item would be a top-level item with a separate rowset in the XML containing the desk. |
| Contact List | The Contact List API returns the corporation and the alliance contact lists. This is accessible by any character who is a member of the corporation. |
| Container Log | The Container Log API shows the corporation container audit log. |
| Corporation Sheet | The Corporation Sheet API returns a complete readout of a corporation's details as shown in the image below. Full access is not required to retrieve information from this API, but a CEO / Director of the corporation can view more information than others. Ordinary members of a corporation (i.e. not CEO or Director) and non-members will see the same limited information. |
| Factional Warfare Statistics | The Factional Warfare Statistics API retrieves statistics for all members of the specified character's corporation including their faction ID and rank and kill and victory point totals for the previous day and week. |
| Industry Jobs | The Industry Jobs API returns a complete list of industry jobs created on behalf of the specified corporation. This API requires the user to have the role of Factory Manager in order to view the information. |
| Kill Log | The Kill Log API displays a list of the 100 most recent kills made by members of the specified corporation. The kill log also contains information about any items dropped in a kill and detailed information about the victim of each kill. The user must either have the role of Director or CEO of the corporation.
Note that there is an optional parameter for this API function called beforeKillID, which allows you to return the most recent kills before the specified killID. |
| Locations | Allows the fetching of coordinate and name data for items owned by the corporation. |
| Market Orders | The Market Orders API retrieves a list of all market orders made on behalf of a corporation.. |
| Medals | The Medals API returns a list of medals that have been created by this corporation.. |
| Member Medals | The Member Medals API returns a list of medals that have been issued to members of the corporation. |
| Member Security | The Member Security API returns the security roles and titles of members in a corporation. |
| Member Security Log | The Member Security Log API returns all info about corporation role changes for members and who made these changes.. |
| Member Tracking | The Member Tracking API allows you to download the member list for player corporations. This list contains more information for CEOs and Directors. You have a choice when accessing the member list to retrieve the data in a CSV or XML formatted dump of every member in the corporation. It is not possible to track members of NPC corporations. Base URL http. |
| NPC Standings | The NPC Standings API returns the standing from NPC corporations and factions as well as agents. Since Tyrannis no longer provides standings towards characters or entities, the Contact List API is used instead.. |
| Outpost List | The Outpost List API allows you to pull information about the corporation's outposts and requires a full API key from the director (or CEO) or the corporation that the outpost belongs to. |
| Outpost Service Detail | The Outpost Service Detail API allows you to retrieve information about the corporation's outpost and requires a full API key from the director (or CEO) of the corporation that owns the outpost. |
| POS Detail | The POS Detail API displays configuration information and fuel amounts for a given Starbase (indicated in the URL as itemID). Note that usage rates are not returned here. |
| POS List | The POS List API returns a list of all Starbases owned by a specified corporation with location information (location ID and moon ID). Note that the requesting character must be a CEO or Director of the corporation. |
| Shareholder | The Shareholder API returns the character and corporation shareholders of a corporation. |
| Titles | The Titles API returns all the titles of a corporation. |
| Wallet Journal | The Wallet Journal API displays a complete record of all wallet activity for all seven of a corporation's wallets. |
| Wallet Transactions | The Wallet Transactions API displays information found on the in-game Transactions tab. This view contains more useful information such as what was sold, how many, what price, where and to whom. |
EVE
| API | Description |
| Alliance List | The Alliance List API retrieves a complete list of all alliances in EVE Online. |
| Certificate Tree | The Certificate Tree API returns a list of certificates in EVE. |
| Character ID | The Character ID API returns a list of character IDs to match a specified comma-delimited list of character names. |
| Character Info | The Character Info API (without a supplied API key) will return the same info on a character as the EVE client would show. With a limited API key it will add total skill points as well as the current ship you are in and its name. When a full API key is supplied, you account balance and your last known location will also be added to the response. |
| Character Name | The Character Name API returns a list of character names to match a specified comma-delimited list of character IDs. |
| Conquerable Station List | The Conquerable Station List API retrieves a list of all conquerable station and outposts and the location information for each. The name and ID of current holding corporation is also indicated in each row. |
| Error List | The Error List API returns a complete list of API errors.
Error types can be separated into four main categories according to the first digit in the three-digit code: 1xx - user input error |
| Factional Warfare Statistics | The FacWarStats API retrieves some general statistics pertaining to Factional Warfare, which is part of the Empyrean Age expansion of EVE-Online. Included in these statistics are information about kills and victory points awarded. This information is further subdivided according to factions, as shown in the image below. |
| Factional Warfare Top Stats | The FW Top Statistics API retrieves kill and victory point information for top characters, corporations and factions (as shown in the image below). The kills section of the returned XML has been expanded in the image below for characters and corporations to show the information nested within. Likewise, victory points have been expanded for factions to show the nested XML. |
| Reference Types | The Ref Types API retrieves a complete list of wallet transaction types, which are used in journal entries. |
| Skill Tree | The Skill Tree API retrieves a list of current in-game skills. The Skill Tree is organized into skill groups and each group contains a number of skills. Non-published skills, like the Polaris skill, are not listed. |
Maps
| API | Description |
| Factional Warfare Systems | The Factional Warfare System activity map contains a list of solar systems, the name of the occupying faction (if applicable) and whether the solar system is contested. This data can be used to generate an activity map of the EVE universe for Factional Warfare. |
| Jumps | The Jumps API retrieves the number of jumps in each solar system, but does not include 0-jump systems. |
| Kills | The Kills API retrieves the number of ship, faction and pod kills organized by solar system. |
| Sovereignty | The Sovereignty API provides an overview of all solar systems with a sovereignty, the sovereignty level and the name and ID of the owning faction. |
Miscellaneous APIs
| API | Description |
| ID to Character Portrait and Corporation/Alliance Logo | This part of the API allows you to fetch the character portrait as well as corporation and alliance logos from the ID. The old character portrait server is still functional, but will eventually be shut down in favor of this service.
The filename for the character portraits are of a general structure <characterID>_<size>.jpg whereas the corporation and alliance logos are stored as PNGs. |
| Server Status | The Server Status API returns the current Tranquility status and the number of players online. |
Top Contributors For This Page
