-
Notifications
You must be signed in to change notification settings - Fork 0
API Wrapper Documentation
List all active player alliances
Resolve a set of alliance IDs to alliance names
- allianceIds String required - A comma separated list of alliance IDs
Public information about an alliance
- allianceId Numeric required - An Eve alliance ID
List all current member corporations of an alliance
- allianceId Numeric required - An EVE alliance ID
Get the icon urls for a alliance
- allianceId Numeric required - An EVE alliance ID
Bulk lookup of character IDs to corporation, alliance and faction
- characters Any required - The character IDs to fetch affiliations for
Resolve a set of character IDs to character names
- characterIds String required - A comma separated list of character IDs
Public information about a character
- characterId Numeric required - An EVE character ID
Return a list of agents research information for a character. The formula for finding the current research points with an agent is: currentPoints = remainderPoints + pointsPerDay * days(currentTime
- characterId Numeric required - ID for a character
- token String - Access token to use, if preferred over a header
scope esi-characters.read_agents_research.v1
Return a list of the characters assets
- characterId Numeric required - Character id of the target character
- token String - Access token to use, if preferred over a header
scope esi-assets.read_assets.v1
Return a list of blueprints the character has
- characterId Numeric required - ID for a character
- token String - Access token to use, if preferred over a header
scope esi-characters.read_blueprints.v1
List your character's personal bookmarks
- characterId Numeric required - An EVE character ID
- token String - Access token to use, if preferred over a header
scope esi-bookmarks.read_character_bookmarks.v1
List your character's personal bookmark folders
- characterId Numeric required - An EVE character ID
- token String - Access token to use, if preferred over a header
scope esi-bookmarks.read_character_bookmarks.v1
Get 50 event summaries from the calendar. If no event ID is given, the resource will return the next 50 chronological event summaries from now. If an event ID is specified, it will return the next 50 chronological event summaries from after that event.
- characterId Numeric required - The character to retrieve events from
- fromEvent Numeric required - The event ID to retrieve events from
- token String - Access token to use, if preferred over a header
scope esi-calendar.read_calendar_events.v1
Get all the information for a specific event
- characterId Numeric required - The character id requesting the event
- eventId Numeric required - The id of the event requested
- token String - Access token to use, if preferred over a header
scope esi-calendar.read_calendar_events.v1
Set your response status to an event
- characterId Numeric required - The character ID requesting the event
- eventId Numeric required - The ID of the event requested
- response Any required - The response value to set, overriding current value.. One of: accepted, declined, tentative
- token String - Access token to use, if preferred over a header
scope esi-calendar.respond_calendar_events.v1
Return chat channels that a character is the owner or an operator of
- characterId Numeric required - ID for a character
- token String - Access token to use, if preferred over a header
scope esi-characters.read_chat_channels.v1
A list of the character's clones
- characterId Numeric required - An EVE character ID
- token String - Access token to use, if preferred over a header
scope esi-clones.read_clones.v1
Bulk delete contacts
- characterId Numeric required - ID for a character
- contactIds Any required - A list of contacts to delete
- token String - Access token to use, if preferred over a header
scope esi-characters.write_contacts.v1
Return contacts of a character
- characterId Numeric required - ID for a character
- page Numeric required - page integer
- token String - Access token to use, if preferred over a header
scope esi-characters.read_contacts.v1
Bulk add contacts with same settings
- characterId Numeric required - ID for a character
- contactIds Any required - A list of contacts to add
- labelId Numeric required - Add a custom label to the new contact
- standing Numeric required - Standing for the new contact
- token String - Access token to use, if preferred over a header
- watched Boolean required - Whether the new contact should be watched, note this is only effective on characters
scope esi-characters.write_contacts.v1
Bulk edit contacts with same settings
- characterId Numeric required - ID for a character
- contactIds Any required - A list of contacts to edit
- labelId Numeric required - Add a custom label to the contact, use 0 for clearing label
- standing Numeric required - Standing for the contact
- token String - Access token to use, if preferred over a header
- watched Boolean required - Whether the contact should be watched, note this is only effective on characters
scope esi-characters.write_contacts.v1
Return custom labels for contacts the character defined
- characterId Numeric required - ID for a character
- token String - Access token to use, if preferred over a header
scope esi-characters.read_contacts.v1
Get a list of all the corporations a character has been a member of
- characterId Numeric required - An EVE character ID
Takes a source character ID in the url and a set of target character ID's in the body, returns a CSPA charge cost
- characterId Numeric required - An EVE character ID
- characters Any required - The target characters to calculate the charge for
- token String - Access token to use, if preferred over a header
scope esi-characters.read_contacts.v1
Return fittings of a character
- characterId Numeric required - ID for a character
- token String - Access token to use, if preferred over a header
scope esi-fittings.read_fittings.v1
Save a new fitting for a character
- characterId Numeric required - ID for a character
- fitting Any - Details about the new fitting
- token String - Access token to use, if preferred over a header
scope esi-fittings.write_fittings.v1
Delete a fitting from a character
- characterId Numeric required - ID for a character
- fittingId Numeric required - ID for a fitting of this character
- token String - Access token to use, if preferred over a header
scope esi-fittings.write_fittings.v1
List industry jobs placed by a character
- characterId Numeric required - An EVE character ID
- includeCompleted Boolean required - Whether retrieve completed character industry jobs as well
- token String - Access token to use, if preferred over a header
scope esi-industry.read_character_jobs.v1
Return a list of character's recent kills and losses
- characterId Numeric required - An EVE character ID
- maxCount Numeric required - How many killmails to return at maximum
- maxKillId Numeric required - Only return killmails with ID smaller than this.
- token String - Access token to use, if preferred over a header
scope esi-killmails.read_killmails.v1
Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable.
- characterId Numeric required - An EVE character ID
- token String - Access token to use, if preferred over a header
scope esi-location.read_location.v1
Return a list of loyalty points for all corporations the character has worked for
- characterId Numeric required - ID for a character
- token String - Access token to use, if preferred over a header
scope esi-characters.read_loyalty.v1
Return the 50 most recent mail headers belonging to the character that match the query criteria. Queries can be filtered by label, and last_mail_id can be used to paginate backwards.
- characterId Numeric required - An EVE character ID
- labels String required - Fetch only mails that match one or more of the given labels
- lastMailId Numeric - List only mail with an ID lower than the given ID, if present
- token String - Access token to use, if preferred over a header
scope esi-mail.read_mail.v1
Create and send a new mail
- characterId Numeric required - The sender's character ID
- mail Any required - The mail to send
- token String - Access token to use, if preferred over a header
scope esi-mail.send_mail.v1
Return a list of the users mail labels, unread counts for each label and a total unread count.
- characterId Numeric required - An EVE character ID
- token String - Access token to use, if preferred over a header
scope esi-mail.read_mail.v1
Create a mail label
- characterId Numeric required - An EVE character ID
- label Any - Label to create
- token String - Access token to use, if preferred over a header
scope esi-mail.organize_mail.v1
Delete a mail label
- characterId Numeric required - An EVE character ID
- labelId Numeric required - An EVE label id
- token String - Access token to use, if preferred over a header
scope esi-mail.organize_mail.v1
Return all mailing lists that the character is subscribed to
- characterId Numeric required - An EVE character ID
- token String - Access token to use, if preferred over a header
scope esi-mail.read_mail.v1
Delete a mail
- characterId Numeric required - An EVE character ID
- mailId Numeric required - An EVE mail ID
- token String - Access token to use, if preferred over a header
scope esi-mail.organize_mail.v1
Return the contents of an EVE mail
- characterId Numeric required - An EVE character ID
- mailId Numeric required - An EVE mail ID
- token String - Access token to use, if preferred over a header
scope esi-mail.read_mail.v1
Update metadata about a mail
- characterId Numeric required - An EVE character ID
- contents Any required - Data used to update the mail
- mailId Numeric required - An EVE mail ID
- token String - Access token to use, if preferred over a header
scope esi-mail.organize_mail.v1
Return a list of medals the character has
- characterId Numeric required - ID for a character
- token String - Access token to use, if preferred over a header
scope esi-characters.read_medals.v1
Checks if the character is currently online
- characterId Numeric required - An EVE character ID
- token String - Access token to use, if preferred over a header
scope esi-location.read_online.v1
Return a list of tasks finished by a character
- characterId Numeric required - ID for a character
- token String - Access token to use, if preferred over a header
scope esi-characters.read_opportunities.v1
List market orders placed by a character
- characterId Numeric required - An EVE character ID
- token String - Access token to use, if preferred over a header
scope esi-markets.read_character_orders.v1
Returns a list of all planetary colonies owned by a character.
- characterId Numeric required - Character id of the target character
- token String - Access token to use, if preferred over a header
scope esi-planets.manage_planets.v1
Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information on this endpoint will not update until this criteria is met.
- characterId Numeric required - Character id of the target character
- planetId Numeric required - Planet id of the target planet
- token String - Access token to use, if preferred over a header
scope esi-planets.manage_planets.v1
Get portrait urls for a character
- characterId Numeric required - An EVE character ID
Returns a character's corporation roles
- characterId Numeric required - A character ID
- token String - Access token to use, if preferred over a header
scope esi-characters.read_corporation_roles.v1
Search for entities that match a given sub
- categories String required - Type of entities to search for
- characterId Numeric required - An EVE character ID
- language String - Search locale
- search String required - The string to search on
- strict Boolean - Whether the search should be a strict match
- token String - Access token to use, if preferred over a header
scope esi-search.search_structures.v1
Get the current ship type, name and id
- characterId Numeric required - An EVE character ID
- token String - Access token to use, if preferred over a header
scope esi-location.read_ship_type.v1
List the configured skill queue for the given character
- characterId Numeric required - Character id of the target character
- token String - Access token to use, if preferred over a header
scope esi-skills.read_skillqueue.v1
List all trained skills for the given character
- characterId Numeric required - An EVE character ID
- token String - Access token to use, if preferred over a header
scope esi-skills.read_skills.v1
Return character standings from agents, NPC corporations, and factions
- characterId Numeric required - ID for a character
- token String - Access token to use, if preferred over a header
scope esi-characters.read_standings.v1
List your wallets and their balances. Characters typically have only one wallet, with wallet_id 1000 being the master wallet.
- characterId Numeric required - An EVE character ID
- token String - Access token to use, if preferred over a header
scope esi-wallet.read_character_wallet.v1
Resolve a set of corporation IDs to corporation names
- corporationIds String required - A comma separated list of corporation IDs
Get a list of npc corporations
Public information about a corporation
- corporationId Numeric required - An Eve corporation ID
Get a list of all the alliances a corporation has been a member of
- corporationId Numeric required - An EVE corporation ID
Get the icon urls for a corporation
- corporationId Numeric required - An EVE corporation ID
Read the current list of members if the calling character is a member.
- corporationId Numeric required - A corporation ID
- token String - Access token to use, if preferred over a header
scope esi-corporations.read_corporation_membership.v1
Return the roles of all members if the character has the personnel manager role or any grantable role.
- corporationId Numeric required - A corporation ID
- token String - Access token to use, if preferred over a header
scope esi-corporations.read_corporation_membership.v1
Get a list of corporation structures
- corporationId Numeric required - A corporation ID
- language String - Language to use in the response
- page Numeric required - Which page to query, 250 structures per page
- token String - Access token to use, if preferred over a header
scope esi-corporations.read_structures.v1
Update the vulnerability window schedule of a corporation structure
- corporationId Numeric required - A corporation ID
- newSchedule Any required - New vulnerability window schedule for the structure
- structureId Numeric required - A structure ID
- token String - Access token to use, if preferred over a header
scope esi-corporations.write_structures.v1
Get a list of dogma attribute ids
Get information on a dogma attribute
- attributeId Numeric required - A dogma attribute ID
Get a list of dogma effect ids
Get information on a dogma effect
- effectId Numeric required - A dogma effect ID
Return details about a fleet
- fleetId Numeric required - ID for a fleet
- token String - Access token to use, if preferred over a header
scope esi-fleets.read_fleet.v1
Update settings about a fleet
- fleetId Numeric required - ID for a fleet
- newSettings Any required - What to update for this fleet
- token String - Access token to use, if preferred over a header
scope esi-fleets.write_fleet.v1
Return information about fleet members
- fleetId Numeric required - ID for a fleet
- language String - Language to use in the response
- token String - Access token to use, if preferred over a header
scope esi-fleets.read_fleet.v1
Invite a character into the fleet, if a character has a CSPA charge set, it is not possible to invite them to the fleet using ESI
- fleetId Numeric required - ID for a fleet
- invitation Any required - Details of the invitation
- token String - Access token to use, if preferred over a header
scope esi-fleets.write_fleet.v1
Kick a fleet member
- fleetId Numeric required - ID for a fleet
- memberId Numeric required - The character ID of a member in this fleet
- token String - Access token to use, if preferred over a header
scope esi-fleets.write_fleet.v1
Move a fleet member around
- fleetId Numeric required - ID for a fleet
- memberId Numeric required - The character ID of a member in this fleet
- movement Any required - Details of the invitation
- token String - Access token to use, if preferred over a header
scope esi-fleets.write_fleet.v1
Delete a fleet squad, only empty squads can be deleted
- fleetId Numeric required - ID for a fleet
- squadId Numeric required - The squad to delete
- token String - Access token to use, if preferred over a header
scope esi-fleets.write_fleet.v1
Rename a fleet squad
- fleetId Numeric required - ID for a fleet
- naming Any required - New name of the squad
- squadId Numeric required - The squad to rename
- token String - Access token to use, if preferred over a header
scope esi-fleets.write_fleet.v1
Return information about wings in a fleet
- fleetId Numeric required - ID for a fleet
- language String - Language to use in the response
- token String - Access token to use, if preferred over a header
scope esi-fleets.read_fleet.v1
Create a new wing in a fleet
- fleetId Numeric required - ID for a fleet
- token String - Access token to use, if preferred over a header
scope esi-fleets.write_fleet.v1
Delete a fleet wing, only empty wings can be deleted. The wing may contain squads, but the squads must be empty
- fleetId Numeric required - ID for a fleet
- token String - Access token to use, if preferred over a header
- wingId Numeric required - The wing to delete
scope esi-fleets.write_fleet.v1
Rename a fleet wing
- fleetId Numeric required - ID for a fleet
- naming Any required - New name of the wing
- token String - Access token to use, if preferred over a header
- wingId Numeric required - The wing to rename
scope esi-fleets.write_fleet.v1
Create a new squad in a fleet
- fleetId Numeric required - ID for a fleet
- token String - Access token to use, if preferred over a header
- wingId Numeric required - The wing_id to create squad in
scope esi-fleets.write_fleet.v1
Return a list of current incursions
Return a list of industry facilities
Return cost indices for solar systems
Return available insurance levels for all ship types
- language String - Language to use in the response
Return a single killmail from its ID and hash
- killmailHash String required - The killmail hash for verification
- killmailId Numeric required - The killmail ID to be queried
Return a list of offers from a specific corporation's loyalty store
- corporationId Numeric required - ID of a corporation
Get a list of item groups
Get information on an item group
- language String - Language to use in the response
- marketGroupId Numeric required - An Eve item group ID
Return a list of prices
Return all orders in a structure
- page Numeric required - Which page to query, starting at 1
- structureId Numeric required - Return orders in this structure
- token String - Access token to use, if preferred over a header
scope esi-markets.structure_markets.v1
Return a list of historical market statistics for the specified type in a region
- regionId Numeric required - Return statistics in this region
- typeId Numeric required - Return statistics for this type
Return a list of orders in a region
- orderType String required - Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders.
- page Numeric required - Which page to query, only used for querying without type_id. Starting at 1
- regionId Numeric required - Return orders in this region
- typeId Numeric required - Return orders only for this type
Return a list of opportunities groups
Return information of an opportunities group
- groupId Numeric required - ID of an opportunities group
- language String - Language to use in the response
Return a list of opportunities tasks
Return information of an opportunities task
- taskId Numeric required - ID of an opportunities task
Get the systems between origin and destination
- avoid String - avoid solar system ID(s)
- connections String - connected solar system pairs
- destination Numeric required - destination solar system ID
- flag String - route security preference
- origin Numeric required - origin solar system ID
Search for entities that match a given sub
- categories String required - Type of entities to search for
- language String - Search locale
- search String required - The string to search on
- strict Boolean - Whether the search should be a strict match
Shows sovereignty data for campaigns.
Shows sovereignty information for solar systems
Shows sovereignty data for structures.
EVE Server status
Set a solar system as autopilot waypoint
- addToBeginning Boolean required - Whether this solar system should be added to the beginning of all waypoints
- clearOtherWaypoints Boolean required - Whether clean other waypoints beforing adding this one
- destinationId Numeric required - The destination to travel to, can be solar system, station or structure's id
- token String - Access token to use, if preferred over a header
scope esi-ui.write_waypoint.v1
Open the contract window inside the client
- contractId Numeric required - The contract to open
- token String - Access token to use, if preferred over a header
scope esi-ui.open_window.v1
Open the information window for a character, corporation or alliance inside the client
- targetId Numeric required - The target to open
- token String - Access token to use, if preferred over a header
scope esi-ui.open_window.v1
Open the market details window for a specific typeID inside the client
- token String - Access token to use, if preferred over a header
- typeId Numeric required - The item type to open in market window
scope esi-ui.open_window.v1
Open the New Mail window, according to settings from the request if applicable
- newMail Any required - The details of mail to create
- token String - Access token to use, if preferred over a header
scope esi-ui.open_window.v1
Get a list of bloodlines
- language String - Language to use in the response
Get a list of item categories
Get information of an item category
- categoryId Numeric required - An Eve item category ID
- language String - Language to use in the response
Get a list of constellations
Get information on a constellation
- constellationId Numeric required - constellation_id integer
- language String - Language to use in the response
Get a list of factions
- language String - Language to use in the response
Get a list of graphics
Get information on a graphic
- graphicId Numeric required - graphic_id integer
Get a list of item groups
- page Numeric required - Which page to query
Get information on an item group
- groupId Numeric required - An Eve item group ID
- language String - Language to use in the response
Get information on a moon
- moonId Numeric required - moon_id integer
Resolve a set of IDs to names and categories. Supported ID's for resolving are: Characters, Corporations, Alliances, Stations, Solar Systems, Constellations, Regions, Types.
- ids Any required - The ids to resolve
Get information on a planet
- planetId Numeric required - planet_id integer
Get a list of character races
- language String - Language to use in the response
Get a list of regions
Get information on a region
- language String - Language to use in the response
- regionId Numeric required - region_id integer
Get information on a planetary factory schematic
- schematicId Numeric required - A PI schematic ID
Get information on a stargate
- stargateId Numeric required - stargate_id integer
Get information on a station
- stationId Numeric required - station_id integer
List all public structures
Returns information on requested structure, if you are on the ACL. Otherwise, returns "Forbidden" for all inputs.
- structureId Numeric required - An Eve structure ID
- token String - Access token to use, if preferred over a header
scope esi-universe.read_structures.v1
Get the number of jumps in solar systems within the last hour, excluding wormhole space. Only systems with jumps will be listed
Get the number of ship, pod and NPC kills per solar system within the last hour, excluding wormhole space. Only systems with kills will be listed
Get a list of solar systems
Get information on a solar system
- language String - Language to use in the response
- systemId Numeric required - system_id integer
Get a list of type ids
- page Numeric required - Which page to query
Get information on a type
- language String - Language to use in the response
- typeId Numeric required - An Eve item type ID
Return a list of wars
- maxWarId Numeric required - Only return wars with ID smaller than this.
Return details about a war
- warId Numeric required - ID for a war
Return a list of kills related to a war
- page Numeric required - Which page to query, starting at 1
- warId Numeric required - A valid war ID