esi v0.1.1 ESI.API.Universe
Summary
Types
Options for Universe.bloodlines/1
Options for Universe.category/2
Options for Universe.constellation/2
Options for Universe.create_names/1
Options for Universe.factions/1
Options for Universe.group/2
Options for Universe.groups/1
Options for Universe.races/1
Options for Universe.region/2
Options for Universe.structure/2
Options for Universe.system/2
Options for Universe.type/2
Options for Universe.types/1
Functions
Get a list of bloodlines
Get a list of item categories
Get information of an item category
Get information on a constellation
Get a list of constellations
Resolve a set of IDs to names and categories. Supported ID’s for resolving are: Characters, Corporations, Alliances, Stations, Solar Systems, Constellations, Regions, Types
Get a list of factions
Get information on a graphic
Get a list of graphics
Get information on an item group
Get a list of item groups
Get information on a moon
Get information on a planet
Get a list of character races
Get information on a region
Get a list of regions
Get information on a planetary factory schematic
Get information on a star
Get information on a stargate
Get information on a station
Returns information on requested structure, if you are on the ACL. Otherwise, returns “Forbidden” for all inputs
List all public structures
Get information on a solar system
Get the number of jumps in solar systems within the last hour ending at the timestamp of the Last-Modified header, 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 ending at the timestamp of the Last-Modified header, excluding wormhole space. Only systems with kills will be listed
Get a list of solar systems
Get information on a type
Get a list of type ids
Types
Options for Universe.bloodlines/1.
:language(DEFAULT::"en-us") — Language to use in the response
Options for Universe.category/2.
:language(DEFAULT::"en-us") — Language to use in the response
constellation_opt() :: {:language, nil | :de | :"en-us" | :fr | :ja | :ru | :zh}
Options for Universe.constellation/2.
:language(DEFAULT::"en-us") — Language to use in the response
Options for Universe.create_names/1.
:ids(REQUIRED) — The ids to resolve
Options for Universe.factions/1.
:language(DEFAULT::"en-us") — Language to use in the response
Options for Universe.group/2.
:language(DEFAULT::"en-us") — Language to use in the response
Options for Universe.groups/1.
:page(DEFAULT:1) — Which page of results to return
Options for Universe.races/1.
:language(DEFAULT::"en-us") — Language to use in the response
Options for Universe.region/2.
:language(DEFAULT::"en-us") — Language to use in the response
Options for Universe.structure/2.
:token— Access token to use if unable to set a header
Options for Universe.system/2.
:language(DEFAULT::"en-us") — Language to use in the response
Options for Universe.type/2.
:language(DEFAULT::"en-us") — Language to use in the response
Options for Universe.types/1.
:page(DEFAULT:1) — Which page of results to return
Functions
Get a list of bloodlines.
Response Example
A list of bloodlines:
[%{"bloodline_id" => 1, "charisma" => 6, "corporation_id" => 1000006,
"description" => "The Deteis are regarded as ...", "intelligence" => 7,
"memory" => 7, "name" => "Deteis", "perception" => 5, "race_id" => 1,
"ship_type_id" => 601, "willpower" => 5}]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_bloodlinespath—/universe/bloodlines/
Get a list of item categories.
Response Example
A list of item category ids:
[1, 2, 3]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_categoriespath—/universe/categories/
category(category_id :: integer, opts :: category_opts) :: ESI.Request.t
Get information of an item category.
Response Example
Information about an item category:
%{"category_id" => 6, "groups" => [25, 26, 27], "name" => "Ship",
"published" => true}Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_categories_category_idpath—/universe/categories/{category_id}/
constellation(constellation_id :: integer, opts :: constellation_opts) :: ESI.Request.t
Get information on a constellation.
Response Example
Information about a constellation:
%{"constellation_id" => 20000009, "name" => "Mekashtad",
"position" => %{"x" => 67796138757472320, "y" => -70591121348560960,
"z" => -59587016159270070}, "region_id" => 10000001,
"systems" => [20000302, 20000303]}Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_constellations_constellation_idpath—/universe/constellations/{constellation_id}/
Get a list of constellations.
Response Example
A list of constellation ids:
[20000001, 20000002]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_constellationspath—/universe/constellations/
Resolve a set of IDs to names and categories. Supported ID’s for resolving are: Characters, Corporations, Alliances, Stations, Solar Systems, Constellations, Regions, Types..
Response Example
List of id/name associations for a set of ID’s. All ID’s must resolve to a name, or nothing will be returned.:
[%{"category" => "character", "id" => 95465499, "name" => "CCP Bartender"},
%{"category" => "solar_system", "id" => 30000142, "name" => "Jita"}]Swagger Source
This function was generated from the following Swagger operation:
operationId—post_universe_namespath—/universe/names/
Get a list of factions.
Response Example
A list of factions:
[%{"corporation_id" => 456, "description" => "blah blah", "faction_id" => 1,
"is_unique" => true, "name" => "Faction", "size_factor" => 1.0,
"solar_system_id" => 123, "station_count" => 1000,
"station_system_count" => 100}]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_factionspath—/universe/factions/
Get information on a graphic.
Response Example
Information about a graphic:
%{"graphic_file" => "res:/dx9/model/worldobject/planet/moon.red",
"graphic_id" => 10}Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_graphics_graphic_idpath—/universe/graphics/{graphic_id}/
Get a list of graphics.
Response Example
A list of graphic ids:
[10, 4106]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_graphicspath—/universe/graphics/
Get information on an item group.
Response Example
Information about an item group:
%{"category_id" => 6, "group_id" => 25, "name" => "Frigate",
"published" => true, "types" => [587, 586, 585]}Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_groups_group_idpath—/universe/groups/{group_id}/
Get a list of item groups.
Response Example
A list of item group ids:
[1, 2, 3]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_groupspath—/universe/groups/
Get information on a moon.
Response Example
Information about a moon:
%{"moon_id" => 40000042, "name" => "Akpivem I - Moon 1",
"position" => %{"x" => 58605102008, "y" => -3066616285, "z" => -55193617920},
"system_id" => 30000003}Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_moons_moon_idpath—/universe/moons/{moon_id}/
Get information on a planet.
Response Example
Information about a planet:
%{"name" => "Akpivem III", "planet_id" => 40000046,
"position" => %{"x" => -189226344497, "y" => 9901605317,
"z" => -254852632979}, "system_id" => 30000003, "type_id" => 13}Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_planets_planet_idpath—/universe/planets/{planet_id}/
Get a list of character races.
Response Example
A list of character races:
[%{"alliance_id" => 500001,
"description" => "Founded on the tenets of patriotism and hard work...",
"name" => "Caldari", "race_id" => 1}]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_racespath—/universe/races/
Get information on a region.
Response Example
Information about a region:
%{"constellations" => [20000302, 20000303],
"description" => "It has long been an established fact of civilization...",
"name" => "Metropolis", "region_id" => 10000042}Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_regions_region_idpath—/universe/regions/{region_id}/
Get a list of regions.
Response Example
A list of region ids:
[11000001, 11000002]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_regionspath—/universe/regions/
Get information on a planetary factory schematic.
Response Example
Public data about a schematic:
%{"cycle_time" => 1800, "schematic_name" => "Bacteria"}Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_schematics_schematic_idpath—/universe/schematics/{schematic_id}/
Get information on a star.
Response Example
Information about a star:
%{"age" => 9398686722, "luminosity" => 0.06615000218153,
"name" => "BKG-Q2 - Star", "radius" => 346600000,
"solar_system_id" => 30004333, "spectral_class" => "K2 V",
"temperature" => 3953, "type_id" => 45033}Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_stars_star_idpath—/universe/stars/{star_id}/
Get information on a stargate.
Response Example
Information about a stargate:
%{"destination" => %{"stargate_id" => 50000056, "system_id" => 30000001},
"name" => "Stargate (Tanoo)",
"position" => %{"x" => -101092761600, "y" => 5279539200,
"z" => 1550503403520}, "stargate_id" => 50000342, "system_id" => 30000003,
"type_id" => 29624}Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_stargates_stargate_idpath—/universe/stargates/{stargate_id}/
Get information on a station.
Response Example
Information about a station:
%{"max_dockable_ship_volume" => 50000000,
"name" => "Jakanerva III - Moon 15 - Prompt Delivery Storage",
"office_rental_cost" => 10000, "owner" => 1000003,
"position" => %{"x" => 165632286720, "y" => 2771804160,
"z" => -2455331266560}, "race_id" => 1, "reprocessing_efficiency" => 0.5,
"reprocessing_stations_take" => 0.05,
"services" => ["courier-missions", "reprocessing-plant", "market",
"repair-facilities", "fitting", "news", "storage", "insurance", "docking",
"office-rental", "loyalty-point-store", "navy-offices"],
"station_id" => 60000277, "system_id" => 30000148, "type_id" => 1531}Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_stations_station_idpath—/universe/stations/{station_id}/
structure(structure_id :: integer, opts :: structure_opts) :: ESI.Request.t
Returns information on requested structure, if you are on the ACL. Otherwise, returns “Forbidden” for all inputs..
Response Example
Data about a structure:
%{"name" => "V-3YG7 VI - The Capital", "solar_system_id" => 30000142}Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_structures_structure_idpath—/universe/structures/{structure_id}/
List all public structures.
Response Example
List of public structure IDs:
[1020988381992, 1020988381991]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_structurespath—/universe/structures/
Get information on a solar system.
Response Example
Information about a solar system:
%{"constellation_id" => 20000001, "name" => "Akpivem",
"planets" => [%{"moons" => [40000042], "planet_id" => 40000041},
%{"planet_id" => 40000043}],
"position" => %{"x" => -91174141133075340, "y" => 43938227486247170,
"z" => -56482824383339900}, "security_class" => "B",
"security_status" => 0.8462923765182495, "star_id" => 40000040,
"stargates" => [50000342], "system_id" => 30000003}Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_systems_system_idpath—/universe/systems/{system_id}/
Get the number of jumps in solar systems within the last hour ending at the timestamp of the Last-Modified header, excluding wormhole space. Only systems with jumps will be listed.
Response Example
A list of systems and number of jumps:
[%{"ship_jumps" => 42, "system_id" => 30002410}]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_system_jumpspath—/universe/system_jumps/
Get the number of ship, pod and NPC kills per solar system within the last hour ending at the timestamp of the Last-Modified header, excluding wormhole space. Only systems with kills will be listed.
Response Example
A list of systems and number of ship, pod and NPC kills:
[%{"npc_kills" => 0, "pod_kills" => 24, "ship_kills" => 42,
"system_id" => 30002410}]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_system_killspath—/universe/system_kills/
Get a list of solar systems.
Response Example
A list of solar system ids:
[30000001, 30000002]Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_systemspath—/universe/systems/
Get information on a type.
Response Example
Information about a type:
%{"description" => "The Rifter is a...", "group_id" => 25, "name" => "Rifter",
"published" => true, "type_id" => 587}Swagger Source
This function was generated from the following Swagger operation:
operationId—get_universe_types_type_idpath—/universe/types/{type_id}/