module ESI::Client::Universe
ESI
universe operations.
Public Instance Methods
Get all character ancestries.
@esi_version legacy @esi_version v1
@param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_ancestries
# File lib/esi/client/universe.rb, line 22 def get_universe_ancestries(headers: {}, params: {}) get("/universe/ancestries/", headers: headers, params: params) end
Get information on an asteroid belt.
@esi_version legacy @esi_version v1
@param asteroid_belt_id [Integer] asteroid_belt_id integer @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Asteroid belt not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_asteroid_belts_asteroid_belt_id
# File lib/esi/client/universe.rb, line 43 def get_universe_asteroid_belt(asteroid_belt_id:, headers: {}, params: {}) get("/universe/asteroid_belts/#{asteroid_belt_id}/", headers: headers, params: params) end
Get a list of bloodlines.
@esi_version legacy @esi_version v1
@param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_bloodlines
# File lib/esi/client/universe.rb, line 63 def get_universe_bloodlines(headers: {}, params: {}) get("/universe/bloodlines/", headers: headers, params: params) end
Get a list of item categories.
@esi_version legacy @esi_version v1
@param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_categories
# File lib/esi/client/universe.rb, line 82 def get_universe_categories(headers: {}, params: {}) get("/universe/categories/", headers: headers, params: params) end
Get information of an item category.
@esi_version legacy @esi_version v1
@param category_id [Integer] An Eve item category ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Category not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_categories_category_id
# File lib/esi/client/universe.rb, line 103 def get_universe_categories_category(category_id:, headers: {}, params: {}) get("/universe/categories/#{category_id}/", headers: headers, params: params) end
Get information on a constellation.
@esi_version legacy @esi_version v1
@param constellation_id [Integer] constellation_id integer @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Constellation not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_constellations_constellation_id
# File lib/esi/client/universe.rb, line 125 def get_universe_constellation(constellation_id:, headers: {}, params: {}) get("/universe/constellations/#{constellation_id}/", headers: headers, params: params) end
Get a list of constellations.
@esi_version legacy @esi_version v1
@param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_constellations
# File lib/esi/client/universe.rb, line 145 def get_universe_constellations(headers: {}, params: {}) get("/universe/constellations/", headers: headers, params: params) end
Get a list of factions.
@esi_version dev @esi_version v2
@param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_factions
# File lib/esi/client/universe.rb, line 164 def get_universe_factions(headers: {}, params: {}) get("/universe/factions/", headers: headers, params: params) end
Get information on a graphic.
@esi_version dev @esi_version legacy @esi_version v1
@param graphic_id [Integer] graphic_id integer @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Graphic not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_graphics_graphic_id
# File lib/esi/client/universe.rb, line 186 def get_universe_graphic(graphic_id:, headers: {}, params: {}) get("/universe/graphics/#{graphic_id}/", headers: headers, params: params) end
Get a list of graphics.
@esi_version legacy @esi_version v1
@param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_graphics
# File lib/esi/client/universe.rb, line 206 def get_universe_graphics(headers: {}, params: {}) get("/universe/graphics/", headers: headers, params: params) end
Get information on an item group.
@esi_version dev @esi_version legacy @esi_version v1
@param group_id [Integer] An Eve item group ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Group not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_groups_group_id
# File lib/esi/client/universe.rb, line 228 def get_universe_group(group_id:, headers: {}, params: {}) get("/universe/groups/#{group_id}/", headers: headers, params: params) end
Get a list of item groups.
@esi_version legacy @esi_version v1
@param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_groups
# File lib/esi/client/universe.rb, line 248 def get_universe_groups(headers: {}, params: {}) get("/universe/groups/", headers: headers, params: params) end
Get information on a moon.
@esi_version legacy @esi_version v1
@param moon_id [Integer] moon_id integer @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Moon not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_moons_moon_id
# File lib/esi/client/universe.rb, line 269 def get_universe_moon(moon_id:, headers: {}, params: {}) get("/universe/moons/#{moon_id}/", headers: headers, params: params) end
Get information on a planet.
@esi_version legacy @esi_version v1
@param planet_id [Integer] planet_id integer @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Planet not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_planets_planet_id
# File lib/esi/client/universe.rb, line 291 def get_universe_planet(planet_id:, headers: {}, params: {}) get("/universe/planets/#{planet_id}/", headers: headers, params: params) end
Get a list of character races.
@esi_version dev @esi_version legacy @esi_version v1
@param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_races
# File lib/esi/client/universe.rb, line 312 def get_universe_races(headers: {}, params: {}) get("/universe/races/", headers: headers, params: params) end
Get information on a region.
@esi_version legacy @esi_version v1
@param region_id [Integer] region_id integer @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Region not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_regions_region_id
# File lib/esi/client/universe.rb, line 333 def get_universe_region(region_id:, headers: {}, params: {}) get("/universe/regions/#{region_id}/", headers: headers, params: params) end
Get a list of regions.
@esi_version legacy @esi_version v1
@param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_regions
# File lib/esi/client/universe.rb, line 353 def get_universe_regions(headers: {}, params: {}) get("/universe/regions/", headers: headers, params: params) end
Get information on a star.
@esi_version legacy @esi_version v1
@param star_id [Integer] star_id integer @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_stars_star_id
# File lib/esi/client/universe.rb, line 373 def get_universe_star(star_id:, headers: {}, params: {}) get("/universe/stars/#{star_id}/", headers: headers, params: params) end
Get information on a stargate.
@esi_version legacy @esi_version v1
@param stargate_id [Integer] stargate_id integer @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Stargate not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_stargates_stargate_id
# File lib/esi/client/universe.rb, line 395 def get_universe_stargate(stargate_id:, headers: {}, params: {}) get("/universe/stargates/#{stargate_id}/", headers: headers, params: params) end
Get information on a station.
@esi_version dev @esi_version v2
@param station_id [Integer] station_id integer @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Station not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_stations_station_id
# File lib/esi/client/universe.rb, line 417 def get_universe_station(station_id:, headers: {}, params: {}) get("/universe/stations/#{station_id}/", headers: headers, params: params) end
Returns information on requested structure if you are on the ACL. Otherwise, returns “Forbidden” for all inputs.
This endpoint is cached for up to 3600 seconds.
This endpoint requires authorization (see {ESI::Client#authorize}).
@esi_scope esi-universe.read_structures.v1
@esi_version v2
@param structure_id [Integer] An Eve structure ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::NotFoundError] Structure not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_structures_structure_id
# File lib/esi/client/universe.rb, line 446 def get_universe_structure(structure_id:, headers: {}, params: {}) get("/universe/structures/#{structure_id}/", headers: headers, params: params) end
List all public structures.
This endpoint is cached for up to 3600 seconds.
@esi_version dev @esi_version legacy @esi_version v1
@param filter [String] Only list public structures that have this service online. Must be one of: `market`, `manufacturing_basic` @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_structures
# File lib/esi/client/universe.rb, line 470 def get_universe_structures(filter: nil, headers: {}, params: {}) params.merge!("filter" => filter) get("/universe/structures/", headers: headers, params: params) end
Get information on a solar system.
@esi_version dev @esi_version v4
@param system_id [Integer] system_id integer @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Solar system not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_systems_system_id
# File lib/esi/client/universe.rb, line 492 def get_universe_system(system_id:, headers: {}, params: {}) get("/universe/systems/#{system_id}/", headers: headers, params: params) end
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.
This endpoint is cached for up to 3600 seconds.
@esi_version legacy @esi_version v1
@param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_system_jumps
# File lib/esi/client/universe.rb, line 514 def get_universe_system_jumps(headers: {}, params: {}) get("/universe/system_jumps/", headers: headers, params: params) end
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.
This endpoint is cached for up to 3600 seconds.
@esi_version v2
@param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_system_kills
# File lib/esi/client/universe.rb, line 534 def get_universe_system_kills(headers: {}, params: {}) get("/universe/system_kills/", headers: headers, params: params) end
Get a list of solar systems.
@esi_version dev @esi_version legacy @esi_version v1
@param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_systems
# File lib/esi/client/universe.rb, line 554 def get_universe_systems(headers: {}, params: {}) get("/universe/systems/", headers: headers, params: params) end
Get information on a type.
@esi_version dev @esi_version v3
@param type_id [Integer] An Eve item type ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Type not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_types_type_id
# File lib/esi/client/universe.rb, line 575 def get_universe_type(type_id:, headers: {}, params: {}) get("/universe/types/#{type_id}/", headers: headers, params: params) end
Get a list of type ids.
@esi_version legacy @esi_version v1
@param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/get_universe_types
# File lib/esi/client/universe.rb, line 595 def get_universe_types(headers: {}, params: {}) get("/universe/types/", headers: headers, params: params) end
Resolve a set of names to IDs in the following categories: agents, alliances, characters, constellations, corporations factions, inventory_types, regions, stations, and systems. Only exact matches will be returned. All names searched for are cached for 12 hours.
@esi_version dev @esi_version legacy @esi_version v1
@param names [Array] The names to resolve @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/post_universe_ids
# File lib/esi/client/universe.rb, line 616 def post_universe_ids(names:, headers: {}, params: {}) post("/universe/ids/", headers: headers, params: params, payload: names) end
Resolve a set of IDs to names and categories. Supported ID's for resolving are: Characters, Corporations, Alliances, Stations, Solar Systems, Constellations, Regions, Types, Factions.
@esi_version dev @esi_version v3
@param ids [Array] The ids to resolve @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers
@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Ensure all IDs are valid before resolving @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
@see esi.evetech.net/ui/#/Universe/post_universe_names
# File lib/esi/client/universe.rb, line 637 def post_universe_names(ids:, headers: {}, params: {}) post("/universe/names/", headers: headers, params: params, payload: ids) end