EveOnline ESI API
This gem implement Ruby API for EveOnline MMORPG (ESI).
Looking for EveOnline SSO OAuth2 Strategy for OmniAuth?
This gem was extracted from EveMonk. Source code of evemonk backend published here.
TOC
- Installation
- Supported ruby versions
- Usage
- Useful links
- Development
- Contributing
- Author
- Contributors
- License
Installation
Add this line to your application's Gemfile:
gem 'eve_online'
And then execute:
bundle
Or install it yourself as:
gem install eve_online
Supported ruby versions
- MRI 2.3
- MRI 2.4
- MRI 2.5
- MRI (head)
- JRuby 9.2.0.0
- JRuby (head)
Supported rails versions
- 4.2
- 5.0
- 5.1
- 5.2
- Edge
Usage examples
Alliance
List all alliances
alliances = EveOnline::ESI::Alliances.new
alliances.scope # => nil
alliances.alliance_ids.size # => 3013
alliances.alliance_ids.first # => 1354830081
Get alliance information
= { alliance_id: 99005443 }
alliance = EveOnline::ESI::Alliance.new()
alliance.scope # => nil
alliance.as_json # => {:creator_corporation_id=>98306624,
# :creator_id=>94195096,
# :date_founded=>Sun, 03 May 2015 19:45:17 UTC +00:00,
# :executor_corporation_id=>98306624,
# :faction_id=>nil,
# :name=>"Kids With Guns Alliance",
# :ticker=>"-KWG-"}
alliance.creator_corporation_id # => 98306624
alliance.creator_id # => 94195096
alliance.date_founded # => Sun, 03 May 2015 19:45:17 UTC +00:00
alliance.executor_corporation_id # => 98306624
alliance.faction_id # => nil
alliance.name # => "Kids With Guns Alliance"
alliance.ticker # => "-KWG-"
List alliance's corporations
= { alliance_id: 99005443 }
alliance_corporations = EveOnline::ESI::AllianceCorporations.new()
alliance_corporations.scope # => nil
alliance_corporations.corporation_ids.size # => 33
alliance_corporations.corporation_ids.first # => 98134807
Get alliance icon
= { alliance_id: 99005443 }
alliance_icon = EveOnline::ESI::AllianceIcon.new()
alliance_icon.scope # => nil
alliance_icon.as_json # => {:icon_medium=>"http://image.eveonline.com/Alliance/99005443_128.png",
# :icon_small=>"http://image.eveonline.com/Alliance/99005443_64.png"}
alliance_icon.icon_medium # => "http://image.eveonline.com/Alliance/99005443_128.png"
alliance_icon.icon_small # => "http://image.eveonline.com/Alliance/99005443_64.png"
Assets
Get character assets
= { token: 'token123', character_id: 90729314, page: 1 }
character_assets = EveOnline::ESI::CharacterAssets.new()
character_assets.scope # => "esi-assets.read_assets.v1"
character_assets.page # => 1
character_assets.total_pages # => 1
character_assets.assets.size # => 486
asset = character_assets.assets.first
asset.as_json # => {:is_blueprint_copy=>true,
# :is_singleton=>true,
# :item_id=>716338097,
# :location_flag=>"Hangar",
# :location_id=>1027847409779,
# :location_type=>"other",
# :quantity=>1
# :type_id=>1010}
asset.is_blueprint_copy # => true
asset.is_singleton # => true
asset.item_id # => 716338097
asset.location_flag # => "Hangar"
asset.location_id # => 1027847409779
asset.location_type # => "other"
asset.quantity # => 1
asset.type_id # => 1010
Get character asset locations
= { token: 'token123', character_id: 1337512245, item_ids: [1001215602246] }
character_assets_locations = EveOnline::ESI::CharacterAssetsLocations.new()
character_assets_locations.scope # => "esi-assets.read_assets.v1"
character_assets_locations.assets_locations.size # => 1
asset_location = character_assets_locations.assets_locations.first
asset_location.as_json # => {:item_id=>1001215602246}
asset_location.item_id # => 1001215602246
asset_location.position.as_json # => {:x=>-928621543221.3319,
# :y=>297645715142.40234,
# :z=>-971212198300.4812}
asset_location.position.x # => -928621543221.3319
asset_location.position.y # => 297645715142.40234
asset_location.position.z # => -971212198300.4812
Get character asset names
= { token: 'token123', character_id: 1337512245, item_ids: [1001215602246] }
character_assets_names = EveOnline::ESI::CharacterAssetsNames.new()
character_assets_names.scope # => "esi-assets.read_assets.v1"
character_assets_names.assets_names.size # => 1
character_asset_name = character_assets_names.assets_names.first
character_asset_name.as_json # => {:item_id=>1001215602246,
# :name=>"HOLE"}
character_asset_name.item_id # => 1001215602246
character_asset_name.name # => "HOLE"
Get corporation assets
Get corporation asset locations
Get corporation asset names
Bookmarks
List bookmarks
= { token: 'token123', character_id: 90729314, page: 1 }
character_bookmarks = EveOnline::ESI::CharacterBookmarks.new()
character_bookmarks.scope # => "esi-bookmarks.read_character_bookmarks.v1"
character_bookmarks.page # => 1
character_bookmarks.total_pages # => 1
character_bookmarks.bookmarks.size # => 20
bookmark = character_bookmarks.bookmarks.first
bookmark.as_json # => {:bookmark_id=>4,
# :coordinate_x=>-144951231521.81625,
# :coordinate_y=>164030047870.25558,
# :coordinate_z=>211467631848.1311,
# :created=>Mon, 09 Jul 2012 22:38:31 UTC +00:00,
# :creator_id=>2112625428,
# :folder_id=>5,
# :item_id=>30003496,
# :item_type_id=>5,
# :label=>"Stargate",
# :location_id=>30003430,
# :notes=>"This is a stargate"}
bookmark.bookmark_id # => 4
bookmark.coordinate_x # => -144951231521.81625
bookmark.coordinate_y # => 164030047870.25558
bookmark.coordinate_z # => 211467631848.1311
bookmark.created # => Mon, 09 Jul 2012 22:38:31 UTC +00:00
bookmark.creator_id # => 2112625428
bookmark.folder_id # => 5
bookmark.item_id # => 30003496
bookmark.item_type_id # => 5
bookmark.label # => "Stargate"
bookmark.location_id # => 30003430
bookmark.notes # => "This is a stargate"
List bookmark folders
= { token: 'token123', character_id: 90729314, page: 1 }
character_bookmark_folders = EveOnline::ESI::CharacterBookmarkFolders.new()
character_bookmark_folders.scope # => "esi-bookmarks.read_character_bookmarks.v1"
character_bookmark_folders.page # => 1
character_bookmark_folders.total_pages # => 1
character_bookmark_folders.bookmark_folders.size # => 1
bookmark_folder = character_bookmark_folders.bookmark_folders.first
bookmark_folder.as_json # => {:folder_id=>5,
# :name=>"Icecream"}
bookmark_folder.folder_id # => 5
bookmark_folder.name # => "Icecream"
List corporation bookmarks
List corporation bookmark folders
Calendar
List calendar event summaries
= { token: 'token123', character_id: 90729314 }
character_calendar = EveOnline::ESI::CharacterCalendar.new()
character_calendar.scope # => "esi-calendar.read_calendar_events.v1"
character_calendar.events.size # => 22
event = character_calendar.events.first
event.as_json # => {:event_date=>Tue, 06 Mar 2018 15:00:59 UTC +00:00,
# :event_id=>1635240,
# :event_response=>"not_responded",
# :importance=>0,
# :title=>"Moon extraction for 66-PMM - GoldMine-5-"}
event.event_date # => Tue, 06 Mar 2018 15:00:59 UTC +00:00
event.event_id # => 1635240
event.event_response # => "not_responded"
event.importance # => 0
event.title # => "Moon extraction for 66-PMM - GoldMine-5-"
# TODO: add from_event support
Get an event
Respond to an event
Get attendees
Character
Get character's public information
= { character_id: 90729314 }
character = EveOnline::ESI::Character.new()
character.scope # => nil
character.as_json # => {:alliance_id=>12345678,
# :ancestry_id=>24,
# :birthday=>Fri, 15 Jan 2010 15:26:00 UTC +00:00,
# :bloodline_id=>4,
# :corporation_id=>1000168,
# :description=>"",
# :faction_id=>500001,
# :gender=>"male",
# :name=>"Green Black",
# :race_id=>2,
# :security_status=>1.8694881661345457}
character.alliance_id # => 12345678
character.ancestry_id # => 24
character.birthday # => Fri, 15 Jan 2010 15:26:00 UTC +00:00
character.bloodline_id # => 4
character.corporation_id # => 1000168
character.description # => ""
character.faction_id # => 500001
character.gender # => "male"
character.name # => "Green Black"
character.race_id # => 2
character.security_status # => 1.8694881661345457
Get agents research
Get blueprints
= { token: 'token123', character_id: 90729314, page: 1 }
character_blueprints = EveOnline::ESI::CharacterBlueprints.new()
character_blueprints.scope # => "esi-characters.read_blueprints.v1"
character_blueprints.page # => 1
character_blueprints.total_pages # => 1
character_blueprints.blueprints.size # => 4
blueprint = character_blueprints.blueprints.first
blueprint.as_json # => {:item_id=>716338097,
# :location_flag=>"Hangar",
# :location_id=>61000032,
# :material_efficiency=>10,
# :quantity=>-2,
# :runs=>300,
# :time_efficiency=>0,
# :type_id=>1010}
blueprint.item_id # => 716338097
blueprint.location_flag # => "Hangar"
blueprint.location_id # => 61000032
blueprint.material_efficiency # => 10
blueprint.quantity # => -2
blueprint.runs # => 300
blueprint.time_efficiency # => 0
blueprint.type_id # => 1010
Get corporation history
Calculate a CSPA charge cost
Get jump fatigue
= { token: 'token123', character_id: 90729314 }
character_fatigue = EveOnline::ESI::CharacterFatigue.new()
character_fatigue.scope # => "esi-characters.read_fatigue.v1"
character_fatigue.as_json # => {:jump_fatigue_expire_date=>nil,
# :last_jump_date=>nil,
# :last_update_date=>nil}
character_fatigue.jump_fatigue_expire_date # => nil
character_fatigue.last_jump_date # => nil
character_fatigue.last_update_date # => nil
# TODO: add real data here
Get medals
Get character notifications
= { token: 'token123', character_id: 90729314 }
character_notifications = EveOnline::ESI::CharacterNotifications.new()
character_notifications.scope # => "esi-characters.read_notifications.v1"
character_notifications.notifications.size # => 500
notification = character_notifications.notifications.first
notification.as_json # => {:is_read=>nil,
# :notification_id=>774328832,
# :sender_id=>1000125,
# :sender_type=>"corporation",
# :text=>"againstID: 99005443\ncost: 0\ndeclaredByID: 98442842\ndelayHours: 24\nhostileState: 0\n"
# :timestamp=>Thu, 01 Mar 2018 13:48:00 UTC +00:00,
# :type=>"AllWarDeclaredMsg"}
notification.is_read # => nil
notification.notification_id # => 774328832
notification.sender_id # => 1000125
notification.sender_type # => "corporation"
notification.text # => "againstID: 99005443\ncost: 0\ndeclaredByID: 98442842\ndelayHours: 24\nhostileState: 0\n"
notification. # => Thu, 01 Mar 2018 13:48:00 UTC +00:00
notification.type # => "AllWarDeclaredMsg"
Get new contact notifications
Get character portraits
= { character_id: 90729314 }
character_portrait = EveOnline::ESI::CharacterPortrait.new()
character_portrait.scope # => nil
character_portrait.as_json # => {:medium=>"http://image.eveonline.com/Character/90729314_128.jpg",
# :large=>"http://image.eveonline.com/Character/90729314_256.jpg",
# :huge=>"http://image.eveonline.com/Character/90729314_512.jpg"
# :small=>"http://image.eveonline.com/Character/90729314_64.jpg"}
character_portrait.medium # => "http://image.eveonline.com/Character/90729314_128.jpg"
character_portrait.large # => "http://image.eveonline.com/Character/90729314_256.jpg"
character_portrait.huge # => "http://image.eveonline.com/Character/90729314_512.jpg"
character_portrait.small # => "http://image.eveonline.com/Character/90729314_64.jpg"
Get character corporation roles
Get standings
= { token: 'token123', character_id: 90729314 }
character_standing = EveOnline::ESI::CharacterStandings.new()
character_standing.scope # => "esi-characters.read_standings.v1"
character_standing.standings.size # => 37
standing = character_standing.standings.first
standing.as_json # => {:from_id=>500001,
# :from_type=>"faction",
# :standing=>0.3303719111639991}
standing.from_id # => 500001
standing.from_type # => "faction"
standing.standing # => 0.3303719111639991
Yearly aggregate stats
Get character corporation titles
Character affiliation
Clones
Get clones
= { token: 'token123', character_id: 90729314 }
character_clones = EveOnline::ESI::CharacterClones.new()
character_clones.scope # => "esi-clones.read_clones.v1"
character_clones.home_location.as_json # => {:location_id=>61000032,
# :location_type=>"station"}
character_clones.jump_clones.size # => 2
jump_clone = character_clones.jump_clones.first
jump_clone.as_json # => {:implants=>[22118],
# :jump_clone_id=>22357400,
# :location_id=>61000032,
# :location_type=>"station",
# :name=>nil}
jump_clone.implants # => [22118]
jump_clone.jump_clone_id # => 22357400
jump_clone.location_id # => 61000032
jump_clone.location_type # => "station"
jump_clone.name # => nil
character_clones.last_clone_jump_date # => Fri, 27 Jul 2012 14:50:11 UTC +00:00
character_clones.last_station_change_date # => Tue, 30 Jun 2015 21:51:13 UTC +00:00
Get active implants
= { token: 'token123', character_id: 90729314 }
character_implants = EveOnline::ESI::CharacterImplants.new()
character_implants.scope # => "esi-clones.read_implants.v1"
character_implants.implant_ids.size # => 5
character_implants.implant_ids # => [9899, 9941, 9942, 9943, 9956]
Contacts
Get alliance contacts
Get alliance contact labels
Delete contacts
Get contacts
Add contacts
Edit contacts
Get contact labels
Get corporation contacts
Get corporation contact labels
Contracts
Get contracts
Get contract bids
Get contract items
Get public contracts
Get public contract bids
Get public contract items
Get corporation contracts
Get corporation contract bids
Get corporation contract items
Corporation
Get corporation information
= { corporation_id: 98468592 }
corporation = EveOnline::ESI::Corporation.new()
corporation.scope # => nil
corporation.as_json # => {:alliance_id=>99001258,
# :ceo_id=>1721864142,
# :creator_id=>1721864142,
# :date_founded=>Mon, 11 Jul 2016 14:22:17 UTC +00:00,
# :description=>"",
# :faction_id=>nil,
# :home_station_id=>60011893,
# :member_count=>60,
# :name=>"Bullshit Bingo Club",
# :shares=>1000,
# :tax_rate=>0.1,
# :ticker=>"BUBIC",
# :corporation_url=>"http://"}
corporation.alliance_id # => 99001258
corporation.ceo_id # => 1721864142
corporation.creator_id # => 1721864142
corporation.date_founded # => Mon, 11 Jul 2016 14:22:17 UTC +00:00
corporation.description # => ""
corporation.faction_id # => nil
corporation.home_station_id # => 60011893
corporation.member_count # => 60
corporation.name # => "Bullshit Bingo Club"
corporation.shares # => 1000
corporation.tax_rate # => 0.1
corporation.ticker # => "BUBIC"
corporation.corporation_url # => "http://"
Get alliance history
Get corporation blueprints
= = { token: 'token123', corporation_id: 98260237, page: 1 }
corporation_blueprints = EveOnline::ESI::CorporationBlueprints.new()
corporation_blueprints.scope # => "esi-corporations.read_blueprints.v1"
corporation_blueprints.page # => 1
corporation_blueprints.total_pages # => 1
corporation_blueprints.blueprints.size # => 387
blueprint = corporation_blueprints.blueprints.first
blueprint.as_json # => {:item_id => 1007566533085,
# :location_flag => "CorpSAG2",
# :location_id => 1024637025781,
# :material_efficiency => 10,
# :quantity => -2,
# :runs => 300,
# :time_efficiency => 20,
# :type_id => 31803}
blueprint.item_id # => 1007566533085
blueprint.location_flag # => "CorpSAG2"
blueprint.location_id # => 1024637025781
blueprint.material_efficiency # => 10
blueprint.quantity # => -2
blueprint.runs # => 300
blueprint.time_efficiency # => 20
blueprint.type_id # => 31803
# TODO: add roles
Get all corporation ALSC logs
Get corporation divisions
Get corporation facilities
Get corporation icon
Get corporation medals
Get corporation issued medals
Get corporation members
Get corporation member limit
Get corporation's members' titles
Track corporation members
Get corporation member roles
Get corporation member roles history
Get corporation shareholders
Get corporation standings
Get corporation starbases (POSes)
Get starbase (POS) detail
Get corporation structures
Get corporation titles
Get npc corporations
Dogma
Get attributes
dogma_attributes = EveOnline::ESI::DogmaAttributes.new
dogma_attributes.scope # => nil
dogma_attributes.attribute_ids.size # => 2385
dogma_attributes.attribute_ids.first # => 2
Get attribute information
= { id: 2 }
dogma_attribute = EveOnline::ESI::DogmaAttribute.new()
dogma_attribute.scope # => nil
dogma_attribute.as_json # => {:attribute_id=>2,
# :default_value=>0.0,
# :description=>"Boolean to store status of online effect",
# :display_name=>"",
# :high_is_good=>true,
# :icon_id=>nil,
# :name=>"isOnline",
# :published=>nil,
# :stackable=>true,
# :unit_id=>nil}
dogma_attribute.attribute_id # => 2
dogma_attribute.default_value # => 0.0
dogma_attribute.description # => "Boolean to store status of online effect"
dogma_attribute.display_name # => ""
dogma_attribute.high_is_good # => true
dogma_attribute.icon_id # => nil
dogma_attribute.name # => "isOnline"
dogma_attribute.published # => nil
dogma_attribute.stackable # => true
dogma_attribute.unit_id # => nil
Get dynamic item information
Get effects
dogma_effects = EveOnline::ESI::DogmaEffects.new
dogma_effects.scope # => nil
dogma_effects.effects_ids.size # => 4123
dogma_effects.effects_ids.first # => 4
Get effect information
= { id: 6717 }
dogma_effect = EveOnline::ESI::DogmaEffect.new()
dogma_effect.scope # => nil
dogma_effect.as_json # => {:description=>"Automatically generated effect",
# :disallow_auto_repeat=>nil,
# :discharge_attribute_id=>nil,
# :display_name=>"",
# :duration_attribute_id=>nil,
# :effect_category=>0,
# :effect_id=>6717,
# :electronic_chance=>nil,
# :falloff_attribute_id=>nil,
# :icon_id=>nil,
# :is_assistance=>nil,
# :is_offensive=>nil,
# :is_warp_safe=>nil,
# :name=>"roleBonusIceOreMiningDurationCap",
# :post_expression=>19291,
# :pre_expression=>19290,
# :published=>nil,
# :range_attribute_id=>nil,
# :range_chance=>nil,
# :tracking_speed_attribute_id=>nil}
dogma_effect.description # => "Automatically generated effect"
dogma_effect.disallow_auto_repeat # => nil
dogma_effect.discharge_attribute_id # => nil
dogma_effect.display_name # => ""
dogma_effect.duration_attribute_id # => nil
dogma_effect.effect_category # => 0
dogma_effect.effect_id # => 6717
dogma_effect.electronic_chance # => nil
dogma_effect.falloff_attribute_id # => nil
dogma_effect.icon_id # => nil
dogma_effect.is_assistance # => nil
dogma_effect.is_offensive # => nil
dogma_effect.is_warp_safe # => nil
dogma_effect.name # => "roleBonusIceOreMiningDurationCap"
dogma_effect.post_expression # => 19291
dogma_effect.pre_expression # => 19290
dogma_effect.published # => nil
dogma_effect.range_attribute_id # => nil
dogma_effect.range_chance # => nil
dogma_effect.tracking_speed_attribute_id # => nil
dogma_effect.modifiers.size # => 4
modifier = dogma_effect.modifiers.first
modifier.as_json # => {:domain=>"shipID",
# :effect_id=>nil,
# :func=>"LocationRequiredSkillModifier",
# :modified_attribute_id=>73,
# :modifying_attribute_id=>2458,
# :operator=>6}
modifier.domain # => "shipID"
modifier.effect_id # => nil
modifier.func # => "LocationRequiredSkillModifier"
modifier.modified_attribute_id # => 73
modifier. # => 2458
modifier.operator # => 6
Faction Warfare
Overview of a character involved in faction warfare
Overview of a corporation involved in faction warfare
List of the top factions in faction warfare
List of the top pilots in faction warfare
List of the top corporations in faction warfare
An overview of statistics about factions involved in faction warfare
Ownership of faction warfare systems
Data about which NPC factions are at war
Fittings
Get fitting
Create fitting
Delete fitting
Fleets
Get character fleet info
Get fleet information
Update fleet
Get fleet members
Create fleet invitation
Kick fleet member
Move fleet member
Delete fleet squad
Rename fleet squad
Get fleet wings
Create fleet wing
Delete fleet wing
Rename fleet wing
Create fleet squad
Incursions
List incursions
Industry
List character industry jobs
= { token: 'token123', character_id: 90729314 }
character_jobs = EveOnline::ESI::CharacterIndustryJobs.new()
character_jobs.scope # => "esi-industry.read_character_jobs.v1"
character_jobs.jobs.size # => 3
job = character_jobs.jobs.first
job.as_json # => {:activity_id=>5,
# :blueprint_id=>1024839597103,
# :blueprint_location_id=>1023579231924,
# :blueprint_type_id=>28607,
# :completed_character_id=>nil,
# :completed_date=>nil,
# :cost=>902034.0,
# :duration=>625697,
# :end_date=>Sat, 25 Nov 2017 16:04:31 UTC +00:00,
# :facility_id=>1023579231924,
# :installer_id=>93997721,
# :job_id=>344732396,
# :licensed_runs=>1,
# :output_location_id=>1023579231924,
# :pause_date=>nil,
# :probability=>1.0,
# :product_type_id=>28607,
# :runs=>2,
# :start_date=>Sat, 18 Nov 2017 10:16:14 UTC +00:00,
# :station_id=>1023579231924,
# :status=>"active",
# :successful_runs=>nil}
job.activity_id # => 5
job.blueprint_id # => 1024839597103
job.blueprint_location_id # => 1023579231924
job.blueprint_type_id # => 28607
job.completed_character_id # => nil
job.completed_date # => nil
job.cost # => 902034.0
job.duration # => 625697
job.end_date # => Sat, 25 Nov 2017 16:04:31 UTC +00:00
job.facility_id # => 1023579231924
job.installer_id # => 93997721
job.job_id # => 344732396
job.licensed_runs # => 1
job.output_location_id # => 1023579231924
job.pause_date # => nil
job.probability # => 1.0
job.product_type_id # => 28607
job.runs # => 2
job.start_date # => Sat, 18 Nov 2017 10:16:14 UTC +00:00
job.station_id # => 1023579231924
job.status # => "active"
job.successful_runs # => nil
Character mining ledger
Moon extraction timers
Corporation mining observers
Observed corporation mining
List corporation industry jobs
= { token: 'token123', corporation_id: 98146630 }
corporation_jobs = EveOnline::ESI::CorporationIndustryJobs.new()
corporation_jobs.scope # => "esi-industry.read_corporation_jobs.v1"
corporation_jobs.page # => 1
corporation_jobs.total_pages # => 1
corporation_jobs.jobs.size # => 23
job = corporation_jobs.jobs.first
job.as_json # => {:activity_id=>1,
# :blueprint_id=>1026042055832,
# :blueprint_location_id=>1024956764558,
# :blueprint_type_id=>28607,
# :completed_character_id=>nil,
# :completed_date=>nil,
# :cost=>19505804.0,
# :duration=>424816,
# :end_date=>Thu, 23 Nov 2017 09:20:30 UTC +00:00,
# :facility_id=>1023579231924,
# :installer_id=>93174304,
# :job_id=>344736432,
# :licensed_runs=>1,
# :location_id=>60006382,
# :output_location_id=>1024956764558,
# :pause_date=>nil,
# :probability=>1.0,
# :product_type_id=>28606,
# :runs=>1,
# :start_date=>Sat, 18 Nov 2017 11:20:14 UTC +00:00,
# :status=>"active",
# :successful_runs=>nil}
job.activity_id # => 1
job.blueprint_id # => 1026042055832
job.blueprint_location_id # => 1024956764558
job.job.blueprint_type_id # => 28607
job.completed_character_id # => nil
job.completed_date # => nil
job.cost # => 19505804.0
job.duration # => 424816
job.end_date # => Thu, 23 Nov 2017 09:20:30 UTC +00:00
job.facility_id # => 1023579231924
job.installer_id # => 93174304
job.job_id # => 344736432
job.licensed_runs # => 1
job.location_id # => 60006382
job.output_location_id # => 1024956764558
job.pause_date # => nil
job.probability # => 1.0
job.product_type_id # => 28606
job.runs # => 1
job.start_date # => Sat, 18 Nov 2017 11:20:14 UTC +00:00
job.status # => "active"
job.successful_runs # => nil
List industry facilities
List solar system cost indices
Insurance
List insurance levels
Killmails
Get a character's recent kills and losses
= { token: 'token123', character_id: 90729314 }
character_killmails = EveOnline::ESI::CharacterKillmailsRecent.new()
character_killmails.scope # => "esi-killmails.read_killmails.v1"
character_killmails.page # => 1
character_killmails.total_pages # => 1
character_killmails.killmails.size # => 1
killmail = character_killmails.killmails.first
killmail.as_json # => {:killmail_hash=>"07f7ef1d7f6090e78d8e85b4a98e680f67b5e9d5",
# :killmail_id=>72410059}
killmail.killmail_hash # => "07f7ef1d7f6090e78d8e85b4a98e680f67b5e9d5"
killmail.killmail_id # => 72410059
Get a corporation's recent kills and losses
= { token: 'token123', corporation_id: 98146630 }
corporation_killmails = EveOnline::ESI::CorporationKillmailsRecent.new()
corporation_killmails.scope # => "esi-killmails.read_corporation_killmails.v1"
corporation_killmails.page # => 1
corporation_killmails.total_pages # => 1
corporation_killmails.killmails.size # => 1
killmail = corporation_killmails.killmails.first
killmail.as_json # => {:killmail_hash=>"07f7ef1d7f6090e78d8e85b4a98e680f67b5e9d5",
# :killmail_id=>72410059}
killmail.killmail_hash # => "07f7ef1d7f6090e78d8e85b4a98e680f67b5e9d5"
killmail.killmail_id # => 72410059
Get a single killmail
Location
Get character location
= { token: 'token123', character_id: 90729314 }
character_location = EveOnline::ESI::CharacterLocation.new()
character_location.scope # => "esi-location.read_location.v1"
character_location.as_json # => {:solar_system_id=>30004971,
# :station_id=>60014689,
# :structure_id=>nil}
character_location.solar_system_id # => 30004971
character_location.station_id # => 60014689
character_location.structure_id # => nil
Get character online
= { token: 'token123', character_id: 90729314 }
character_online = EveOnline::ESI::CharacterOnline.new()
character_online.scope # => "esi-location.read_online.v1"
character_online.as_json # => {:last_login=>Sun, 15 Jan 2017 11:39:24 UTC +00:00,
# :last_logout=>Sun, 15 Jan 2017 11:31:22 UTC +00:00,
# :logins=>370,
# :online=>false}
character_online.last_login # => Sun, 15 Jan 2017 11:39:24 UTC +00:00
character_online.last_logout # => Sun, 15 Jan 2017 11:31:22 UTC +00:00
character_online.logins # => 370
character_online.online # => false
Get current ship
= { token: 'token123', character_id: 90729314 }
character_ship = EveOnline::ESI::CharacterShip.new()
character_ship.scope # => "esi-location.read_ship_type.v1"
character_ship.as_json # => {:ship_item_id=>1002312158069,
# :ship_name=>"Green Black's Velator",
# :ship_type_id=>606}
character_ship.ship_item_id # => 1002312158069
character_ship.ship_name # => "Green Black's Velator"
character_ship.ship_type_id # => 606
Loyalty
Get loyalty points
= { token: 'token123', character_id: 90729314 }
character_loyalty_points = EveOnline::ESI::CharacterLoyaltyPoints.new()
character_loyalty_points.scope # => "esi-characters.read_loyalty.v1"
character_loyalty_points.loyalty_points.size # => 5
loyalty_point = character_loyalty_points.loyalty_points.first
loyalty_point.as_json # => {:corporation_id=>1000035, :loyalty_points=>14163}
loyalty_point.corporation_id # => 1000035
loyalty_point.loyalty_points # => 14163
List loyalty store offers
Return mail headers
Send a new mail
Delete a mail
Return a mail
Update metadata about a mail
Get mail labels and unread counts
Create a mail label
Delete a mail label
Return mailing list subscriptions
Market
List open orders from a character
= { token: 'token123', character_id: 90729314 }
character_orders = EveOnline::ESI::CharacterOrders.new()
character_orders.scope
character_orders.orders.size
order = character_orders.orders.first
order.as_json
order.duration
order.escrow
order.is_buy_order
order.is_corporation
order.issued
order.location_id
order.min_volume
order.order_id
order.price
order.range
order.region_id
order.type_id
order.volume_remain
order.volume_total
# TODO: update example
List historical orders by a character
List open orders from a corporation
= { token: 'token123', corporation_id: 1000168, page: 1 }
corporation_orders = EveOnline::ESI::CorporationOrders.new()
corporation_orders.scope
corporation_orders.page # => 1
corporation_orders.total_pages # => 1
corporation_orders.orders.size
order = corporation_orders.orders.first
order.as_json
order.duration
order.escrow
order.is_buy_order
order.issued
order.issued_by
order.location_id
order.min_volume
order.order_id
order.price
order.range
order.region_id
order.type_id
order.volume_remain
order.volume_total
order.wallet_division
# TODO: update example
# TODO: update
List historical orders from a corporation
List historical market statistics in a region
= { region_id: 10000002, type_id: 28606 }
market_history = EveOnline::ESI::MarketHistory.new()
market_history.scope # => nil
statistics = market_history.history
statistics.size # => 417
stats_today = statistics.last
stats_today.as_json # => {:average=>754702326.19,
# :date=>Fri, 24 Nov 2017 00:00:00 UTC +00:00,
# :highest=>769999999.99,
# :lowest=>701100002.49,
# :order_count=>52,
# :volume=>52}
stats_today.average # => 754702326.19
stats_today.date # => Fri, 24 Nov 2017 00:00:00 UTC +00:00
stats_today.highest # => 769999999.99
stats_today.lowest # => 701100002.49
stats_today.order_count # => 52
stats_today.volume # => 52
List orders in a region
List type IDs relevant to a market
Get item groups
Get item group information
List market prices
List orders in a structure
Opportunities
Get a character's completed task
Get opportunities groups
Get opportunities group
Get opportunities tasks
Get opportunities task
Planetary Interaction
Get colonies
Get colony layout
List corporation customs offices
Get schematic information
Routes
Get route
Search
Search on a string (search for something in character stuff)
Search on a string
Skills
Get character attributes
= { token: 'token123', character_id: 90729314 }
character_attributes = EveOnline::ESI::CharacterAttributes.new()
character_attributes.scope # => "esi-skills.read_skills.v1"
character_attributes.as_json # => {:accrued_remap_cooldown_date=>Sun, 06 May 2012 12:58:06 UTC +00:00,
# :bonus_remaps=>2,
# :charisma=>20,
# :intelligence=>24,
# :last_remap_date=>Sat, 07 May 2011 12:58:06 UTC +00:00,
# :memory=>24,
# :perception=>23,
# :willpower=>23}
character_attributes.accrued_remap_cooldown_date # => Sun, 06 May 2012 12:58:06 UTC +00:00
character_attributes.bonus_remaps # => 2
character_attributes.charisma # => 20
character_attributes.intelligence # => 24
character_attributes.last_remap_date # => Sat, 07 May 2011 12:58:06 UTC +00:00
character_attributes.memory # => 24
character_attributes.perception # => 23
character_attributes.willpower # => 23
Get character's skill queue
= { token: 'token123', character_id: 90729314 }
character_skill_queue = EveOnline::ESI::CharacterSkillQueue.new()
character_skill_queue.scope # => "esi-skills.read_skillqueue.v1"
character_skill_queue.skills.size # => 50
skill_queue_entry = character_skill_queue.skills.first
skill_queue_entry.as_json # => {:finish_date=>Mon, 16 Jan 2017 03:00:35 UTC +00:00,
# :finished_level=>3,
# :level_end_sp=>40000,
# :level_start_sp=>7072
# :queue_position=>0,
# :skill_id=>12487,
# :start_date=>Sun, 15 Jan 2017 11:38:25 UTC +00:00,
# :training_start_sp=>7263}
skill_queue_entry.finish_date # => Mon, 16 Jan 2017 03:00:35 UTC +00:00
skill_queue_entry.finished_level # => 3
skill_queue_entry.level_end_sp # => 40000
skill_queue_entry.level_start_sp # => 7072
skill_queue_entry.queue_position # => 0
skill_queue_entry.skill_id # => 12487
skill_queue_entry.start_date # => Sun, 15 Jan 2017 11:38:25 UTC +00:00
skill_queue_entry.training_start_sp # => 7263
Get character skills
= { token: 'token123', character_id: 90729314 }
character_skills = EveOnline::ESI::CharacterSkills.new()
character_skills.scope # => "esi-skills.read_skills.v1"
character_skills.as_json # => {:total_sp=>50362576, :unallocated_sp=>656000}
character_skills.skills.size # => 179
skill = character_skills.skills.first
skill.as_json # => {:active_skill_level=>0,
# :skill_id=>22536,
# :skillpoints_in_skill=>500,
# :trained_skill_level=>1}
skill.active_skill_level # => 0
skill.skill_id # => 22536
skill.skillpoints_in_skill # => 500
skill.trained_skill_level # => 1
character_skills.total_sp # => 50362576
character_skills.unallocated_sp # => 656000
Sovereignty
List sovereignty campaigns
List sovereignty of systems
List sovereignty structures
Status
Retrieve the uptime and player counts
server_status = EveOnline::ESI::ServerStatus.new
server_status.scope # => nil
server_status.as_json # => {:players=>34545,
# :server_version=>"1135520",
# :start_time=>Tue, 11 Apr 2017 11:05:35 UTC +00:00,
# :vip=>nil}
server_status.players # => 34545
server_status.server_version # => "1135520"
server_status.start_time # => Tue, 11 Apr 2017 11:05:35 UTC +00:00
server_status.vip # => nil
Universe
Get ancestries
= { language: 'en-us' }
ancestries = EveOnline::ESI::Ancestries.new()
ancestries.scope # => nil
ancestries.ancestries.size # => 42
ancestry = ancestries.ancestries.first
ancestry.as_json # => {:bloodline_id=>4,
# :description=>"Millions of slaves within the Amarr Empire dream of escape...",
# :icon_id=>1664,
# :ancestry_id=>24,
# :name=>"Slave Child",
# :short_description=>"Torn from the cold and brought to the warmth of a new life."}
ancestry.bloodline_id # => 4
ancestry.description # => "Millions of slaves within the Amarr Empire dream of escape..."
ancestry.icon_id # => 1664
ancestry.ancestry_id # => 24
ancestry.name # => "Slave Child"
ancestry.short_description # => "Torn from the cold and brought to the warmth of a new life."
Get asteroid belt information
= { id: 40000003 }
asteroid_belt = EveOnline::ESI::UniverseAsteroidBelt.new()
asteroid_belt.scope # => nil
asteroid_belt.as_json # => {:name=>"Tanoo I - Asteroid Belt 1",
# :system_id=>30000001}
asteroid_belt.name # => "Tanoo I - Asteroid Belt 1"
asteroid_belt.system_id # => 30000001
asteroid_belt.position.as_json # => {:x=>161967513600.0,
# :y=>21288837120.0,
# :z=>-73505464320.0}
asteroid_belt.position.x # => 161967513600.0
asteroid_belt.position.y # => 21288837120.0
asteroid_belt.position.z # => -73505464320.0
Get bloodlines
= { language: 'en-us' }
bloodlines = EveOnline::ESI::Bloodlines.new()
bloodlines.scope # => nil
bloodlines.bloodlines.size # => 15
bloodline = bloodlines.bloodlines.first
bloodline.as_json # => {:bloodline_id=>4,
# :charisma=>6,
# :corporation_id=>1000049,
# :description=>"A martial, strong-willed people, the Brutor...",
# :intelligence=>4,
# :memory=>4,
# :name=>"Brutor",
# :perception=>9,
# :race_id=>2,
# :ship_type_id=>588,
# :willpower=>7}
bloodline.bloodline_id # => 4
bloodline.charisma # => 6
bloodline.corporation_id # => 1000049
bloodline.description # => "A martial, strong-willed people, the Brutor..."
bloodline.intelligence # => 4
bloodline.memory # => 4
bloodline.name # => "Brutor"
bloodline.perception # => 9
bloodline.race_id # => 2
bloodline.ship_type_id # => 588
bloodline.willpower # => 7
Get item categories
categories = EveOnline::ESI::UniverseCategories.new
categories.scope # => nil
categories.category_ids.size # => 43
categories.category_ids.first # => 0
Get item category information
= { id: 6, language: 'en-us' }
category = EveOnline::ESI::UniverseCategory.new()
category.scope # => nil
category.as_json # => {:category_id=>6,
# :name=>"Ship",
# :published=>true}
category.category_id # => 6
category.name # => "Ship"
category.published # => true
category.group_ids.size # => 46
category.group_ids.first # => 25
Get constellations
constellations = EveOnline::ESI::UniverseConstellations.new
constellations.scope # => nil
constellations.constellation_ids.size # => 1146
constellations.constellation_ids.first # => 20000001
Get constellation information
= { id: 20000001, language: 'en-us' }
constellation = EveOnline::ESI::UniverseConstellation.new()
constellation.scope # => nil
constellation.as_json # => {:constellation_id=>20000001,
# :name=>"San Matar",
# :region_id=>10000001,
# :systems=>[30000001, 30000002, 30000003, 30000004, 30000005, 30000006, 30000007, 30000008]}
constellation.constellation_id # => 20000001
constellation.name # => "San Matar"
constellation.region_id # => 10000001
constellation.systems # => [30000001, 30000002, 30000003, 30000004, 30000005, 30000006, 30000007, 30000008]
constellation.position.as_json # => {:x=>-9.404655970099134e+16,
# :y=>4.952015315379885e+16,
# :z=>-4.273873181840197e+16}
constellation.position.x # => -9.404655970099134e+16
constellation.position.y # => 4.952015315379885e+16
constellation.position.z # => -4.273873181840197e+16
Get factions
= { language: 'en-us' }
factions = EveOnline::ESI::Factions.new()
factions.scope # => nil
factions.factions.size # => 22
faction = factions.factions.first
faction.as_json # => {:corporation_id=>1000051,
# :description=>"The Minmatar Republic was formed over a century ago when the Minmatar threw...",
# :faction_id=>500002,
# :is_unique=>true,
# :militia_corporation_id=>1000182,
# :name=>"Minmatar Republic",
# :size_factor=>5.0,
# :solar_system_id=>30002544,
# :station_count=>570,
# :station_system_count=>291}
faction.corporation_id # => 1000051
faction.description # => "The Minmatar Republic was formed over a century ago when the Minmatar threw..."
faction.faction_id # => 500002
faction.is_unique # => true
faction.militia_corporation_id # => 1000182
faction.name # => "Minmatar Republic"
faction.size_factor # => 5.0
faction.solar_system_id # => 30002544
faction.station_count # => 570
faction.station_system_count # => 291
Get graphics
graphics = EveOnline::ESI::UniverseGraphics.new
graphics.scope # => nil
graphics.graphic_ids.size # => 3624
graphics.graphic_ids.first # => 20481
Get graphic information
= { id: 20481 }
graphic = EveOnline::ESI::UniverseGraphic.new()
graphic.scope # => nil
graphic.as_json # => {:collision_file=>nil,
# :graphic_file=>nil,
# :graphic_id=>20481,
# :icon_folder=>nil,
# :sof_dna=>"ai1_t1:tash-murkon:amarr",
# :sof_fation_name=>"tash-murkon",
# :sof_hull_name=>"ai1_t1",
# :sof_race_name=>"amarr"}
graphic.collision_file # => nil
graphic.graphic_file # => nil
graphic.graphic_id # => 20481
graphic.icon_folder # => nil
graphic.sof_dna # => "ai1_t1:tash-murkon:amarr"
graphic.sof_fation_name # => "tash-murkon"
graphic.sof_hull_name # => "ai1_t1"
graphic.sof_race_name # => "amarr"
Get item groups
= { page: 1 }
groups = EveOnline::ESI::UniverseGroups.new()
groups.scope # => nil
groups.page # => 1
groups.total_pages # => 2
groups.group_ids.size # => 1000
groups.group_ids.first # => 0
Get item group information
= { id: 450, language: 'en-us' }
group = EveOnline::ESI::UniverseGroup.new()
group.scope # => nil
group.as_json # => {:category_id=>25,
# :group_id=>450,
# :name=>"Arkonor",
# :published=>true}
group.category_id # => 25
group.group_id # => 450
group.name # => "Arkonor"
group.published # => true
group.type_ids # => [22, 17425, 17426, 26852, 28367, 28385, 28387, 28625, 46678, 46691]
Bulk names to IDs
Get moon information
= { id: 40000004 }
moon = EveOnline::ESI::UniverseMoon.new()
moon.scope # => nil
moon.as_json # => {:moon_id=>40000004,
# :name=>"Tanoo I - Moon 1",
# :system_id=>30000001}
moon.moon_id # => 40000004
moon.name # => "Tanoo I - Moon 1"
moon.system_id # => 30000001
moon.position.as_json # => {:x=>162088094286.0,
# :y=>21314854783.0,
# :z=>-73598621491.0}
moon.position.x # => 162088094286.0
moon.position.y # => 21314854783.0
moon.position.z # => -73598621491.0
Get names and categories for a set of ID's
Get planet information
= { id: 40000002 }
planet = EveOnline::ESI::UniversePlanet.new()
planet.scope # => nil
planet.as_json # => {:name=>"Tanoo I",
# :planet_id=>40000002,
# :system_id=>30000001,
# :type_id=>11}
planet.name # => "Tanoo I"
planet.planet_id # => 40000002
planet.system_id # => 30000001
planet.type_id # => 11
planet.position.as_json # => {:x=>161891117336.0,
# :y=>21288951986.0,
# :z=>-73529712226.0}
planet.position.x # => 161891117336.0
planet.position.y # => 21288951986.0
planet.position.z # => -73529712226.0
Get character races
= { language: 'en-us' }
races = EveOnline::ESI::Races.new()
races.scope # => nil
races.races.size # => 4
race = races.races.first
race.as_json # => {:alliance_id=>500002,
# :description=>"Once a thriving tribal civilization, the Minmatar...",
# :name=>"Minmatar",
# :race_id=>2}
race.alliance_id # => 500002
race.description # => "Once a thriving tribal civilization, the Minmatar..."
race.name # => "Minmatar"
race.race_id # => 2
Get regions
regions = EveOnline::ESI::UniverseRegions.new
regions.scope # => nil
regions.universe_region_ids.size # => 106
regions.universe_region_ids.first # => 10000001
Get region information
= { id: 10000001, language: 'en-us' }
region = EveOnline::ESI::UniverseRegion.new()
region.scope # => nil
region.as_json # => {:constellations=>[20000001,20000002,20000003,20000016],
# :description=>"The Derelik region...",
# :name=>"Derelik",
# :region_id=>10000001}
region.constellations # => [20000001,20000002,20000003,20000016]
region.description # => "The Derelik region..."
region.name # => "Derelik"
region.region_id # => 10000001
Get stargate information
= { id: 50000056 }
stargate = EveOnline::ESI::UniverseStargate.new()
stargate.scope # => nil
stargate.as_json # => {:name=>"Stargate (Akpivem)",
# :stargate_id=>50000056,
# :system_id=>30000001,
# :type_id=>29624}
stargate.name # => "Stargate (Akpivem)"
stargate.stargate_id # => 50000056
stargate.system_id # => 30000001
stargate.type_id # => 29624
stargate.destination.as_json # => {:stargate_id=>50000342,
# :system_id=>30000003}
stargate.destination.stargate_id # => 50000342
stargate.destination.system_id # => 30000003
stargate.position.as_json # => {:x=>331516354560.0,
# :y=>43597455360.0,
# :z=>-586353991680.0}
stargate.position.x # => 331516354560.0
stargate.position.y # => 43597455360.0
stargate.position.z # => -586353991680.0
Get star information
= { id: 40000001 }
star = EveOnline::ESI::UniverseStar.new()
star.scope # => nil
star.as_json # => {:age=>14262808228,
# :luminosity=>0.01575000025331974,
# :name=>"Tanoo - Star",
# :radius=>126700000,
# :solar_system_id=>30000001,
# :spectral_class=>"K2 V",
# :temperature=>4567,
# :type_id=>45041}
star.age # => 14262808228
star.luminosity # => 0.01575000025331974
star.name # => "Tanoo - Star"
star.radius # => 126700000
star.solar_system_id # => 30000001
star.spectral_class # => "K2 V"
star.temperature # => 4567
star.type_id # => 45041
# options = { id: 60012526 }
# star = EveOnline::ESI::UniverseStar.new(options) => 500
Get station information
= { id: 60012526 }
station = EveOnline::ESI::UniverseStation.new()
station.scope # => nil
station.as_json # => {:max_dockable_ship_volume=>50000000.0,
# :name=>"Tanoo V - Moon 1 - Ammatar Consulate Bureau",
# :office_rental_cost=>422500.0,
# :owner=>1000126,
# :race_id=>2,
# :reprocessing_efficiency=>0.5,
# :reprocessing_stations_take=>0.05,
# :services=>
# ["bounty-missions",
# "courier-missions",
# "interbus",
# "reprocessing-plant",
# "market",
# "stock-exchange",
# "cloning",
# "repair-facilities",
# "fitting",
# "news",
# "insurance",
# "docking",
# "office-rental",
# "loyalty-point-store",
# "navy-offices",
# "security-offices"],
# :station_id=>60012526,
# :system_id=>30000001,
# :type_id=>2502}
station.max_dockable_ship_volume # => 50000000.0
station.name # => "Tanoo V - Moon 1 - Ammatar Consulate Bureau"
station.office_rental_cost # => 422500.0
station.owner # => 1000126
station.race_id # => 2
station.reprocessing_efficiency # => 0.5
station.reprocessing_stations_take # => 0.05
station.services # => ["bounty-missions",
# "courier-missions",
# "interbus",
# "reprocessing-plant",
# "market",
# "stock-exchange",
# "cloning",
# "repair-facilities",
# "fitting",
# "news",
# "insurance",
# "docking",
# "office-rental",
# "loyalty-point-store",
# "navy-offices",
# "security-offices"]
station.station_id # => 60012526
station.system_id # => 30000001
station.type_id # => 2502
station.position.as_json # => {:x=>-1106145239040.0,
# :y=>-145460060160.0,
# :z=>182618726400.0}
station.position.x # => -1106145239040.0
station.position.y # => -145460060160.0
station.position.z # => 182618726400.0
List all public structures
structures = EveOnline::ESI::UniverseStructures.new
structures.scope # => nil
structures.structure_ids.size # => 4181
structures.structure_ids.first # => 1028178624512
Get structure information
Get system jumps
system_jumps = EveOnline::ESI::UniverseSystemJumps.new
system_jumps.scope # => nil
system_jumps.system_jumps.size # => 4891
jump = system_jumps.system_jumps.first
jump.as_json # => {:ship_jumps=>22, :system_id=>30005327}
jump.ship_jumps # => 22
jump.system_id # => 30005327
Get system kills
system_kills = EveOnline::ESI::UniverseSystemKills.new
system_kills.scope # => nil
system_kills.system_kills.size # => 3185
system_kill = system_kills.system_kills.first
system_kill.as_json # => {:npc_kills=>231,
# :pod_kills=>0,
# :ship_kills=>0,
# :system_id=>30001746}
system_kill.npc_kills # => 231
system_kill.pod_kills # => 0
system_kill.ship_kills # => 0
system_kill.system_id # => 30001746
Get solar systems
systems = EveOnline::ESI::UniverseSystems.new
systems.scope # => nil
systems.universe_system_ids.size # => 8285
systems.universe_system_ids.first # => 30000001
Get solar system information
= { id: 30000001, language: 'en-us' }
system = EveOnline::ESI::UniverseSystem.new()
system.scope # => nil
system.as_json # => {:constellation_id=>20000001,
# :name=>"Tanoo",
# :security_class=>"B",
# :security_status=>0.8583240509033203,
# :star_id=>40000001,
# :system_id=>30000001}
system.constellation_id # => 20000001
system.name # => "Tanoo"
system.security_class # => "B"
system.security_status # => 0.8583240509033203
system.star_id # => 40000001
system.system_id # => 30000001
system.position.as_json # => {:x=>-8.851079259998058e+16,
# :y=>4.236944396687888e+16,
# :z=>-4.451352534647966e+16}
system.position.x # => -8.851079259998058e+16
system.position.y # => 4.236944396687888e+16
system.position.z # => -4.451352534647966e+16
system.planets.size # => 6
planet = system.planets.first
planet.as_json # => {:planet_id=>40000002}
planet.planet_id # => 40000002
planet.asteroid_belt_ids # => [40000003]
planet.moon_ids # => [40000004]
system.stargate_ids # => [50000056, 50000057, 50000058]
system.station_ids # => [60012526, 60014437]
Get types
= { page: 1 }
types = EveOnline::ESI::UniverseTypes.new()
types.scope # => nil
types.page # => 1
types.total_pages # => 35
types.universe_type_ids.size # => 1000
types.universe_type_ids.first # => 0
Get type information
= { id: 192, language: 'en-us' }
type = EveOnline::ESI::UniverseType.new()
type.scope # => nil
type.as_json # => {:capacity=>0.0,
# :description=>"Medium Projectile Ammo...",
# :graphic_id=>1297,
# :group_id=>83,
# :icon_id=>1297,
# :market_group_id=>112,
# :mass=>1.0,
# :name=>"Phased Plasma M",
# :packaged_volume=>0.0125,
# :portion_size=>100,
# :published=>true,
# :radius=>1.0,
# :type_id=>192,
# :volume=>0.0125}
type.capacity # => 0.0
type.description # => "Medium Projectile Ammo..."
type.graphic_id # => 1297
type.group_id # => 83
type.icon_id # => 1297
type.market_group_id # => 112
type.mass # => 1.0
type.name # => "Phased Plasma M"
type.packaged_volume # => 0.0125
type.portion_size # => 100
type.published # => true
type.radius # => 1.0
type.type_id # => 192
type.volume # => 0.0125
type.dogma_attributes.size # => 17
type_dogma_attribute = type.dogma_attributes.first
type_dogma_attribute.as_json # => {:attribute_id=>128,
# :value=>2.0}
dogma_attribute.attribute_id # => 128
dogma_attribute.value # => 2.0
type.dogma_effects.size # => 3
type_dogma_effect = type.dogma_effects.first
type_dogma_effect.as_json # => {:effect_id=>596,
# :is_default=>false}
type_dogma_effect.effect_id # => 596
type_dogma_effect.is_default # => false
User Interface
Set Autopilot Waypoint
Open Contract Window
Open Information Window
Open Market Details
Open New Mail Window
Wallet
Get a character's wallet balance
= { token: 'token123', character_id: 90729314 }
character_wallet = EveOnline::ESI::CharacterWallet.new()
character_wallet.scope # => "esi-wallet.read_character_wallet.v1"
character_wallet.as_json # => {:wallet=>409488252.49}
character_wallet.wallet # => 409488252.49
Get character wallet journal
= { token: 'token123', character_id: 90729314, page: 1 }
character_wallet_journal = EveOnline::ESI::CharacterWalletJournal.new()
character_wallet_journal.scope # => "esi-wallet.read_character_wallet.v1"
character_wallet_journal.page # => 1
character_wallet_journal.total_pages # => 1
character_wallet_journal.wallet_journal_entries.size # => 1
wallet_journal_entry = character_wallet_journal.wallet_journal_entries.first
wallet_journal_entry.as_json
wallet_journal_entry.amount
wallet_journal_entry.balance
wallet_journal_entry.context_id
wallet_journal_entry.context_id_type
wallet_journal_entry.date
wallet_journal_entry.description
wallet_journal_entry.first_party_id
wallet_journal_entry.id
wallet_journal_entry.reason
wallet_journal_entry.ref_type
wallet_journal_entry.second_party_id
wallet_journal_entry.tax
wallet_journal_entry.tax_receiver_id
# TODO: update example
Get wallet transactions
Returns a corporation's wallet balance
Get corporation wallet journal
Get corporation wallet transactions
Wars
List wars
wars = EveOnline::ESI::Wars.new
wars.scope # => nil
wars.war_ids.size # => 2000
wars.war_ids.first # => 615639
# TODO: max_war_id
Get war information
List kills for a war
= { war_id: 615578 }
war_killmails = EveOnline::ESI::WarKillmails.new()
war_killmails.scope # => nil
war_killmails.page # => 1
war_killmails.total_pages # => 1
war_killmails.killmails.size # => 1
killmail = war_killmails.killmails.first
killmail.as_json # => {:killmail_hash=>"07f7ef1d7f6090e78d8e85b4a98e680f67b5e9d5",
# :killmail_id=>72410059}
killmail.killmail_hash # => "07f7ef1d7f6090e78d8e85b4a98e680f67b5e9d5"
killmail.killmail_id # => 72410059
Exceptions
If you want to catch all exceptions rescue EveOnline::Exceptions::Base. E.g.:
begin
races = EveOnline::ESI::Races.new
race = races.races.first
race.as_json
rescue EveOnline::Exceptions::Base
# some logic for handle exception
end
List of exceptions:
EveOnline::Exceptions::NoContentwhen response returns status 204 without body.EveOnline::Exceptions::BadRequestwhen response returns status 400.EveOnline::Exceptions::Unauthorizedwhen response returns status 401.EveOnline::Exceptions::Forbiddenwhen response returns status 403.EveOnline::Exceptions::ResourceNotFoundwhen response returns status 404.EveOnline::Exceptions::InternalServerErrorwhen response returns status 500.EveOnline::Exceptions::BadGatewaywhen response returns status 502.EveOnline::Exceptions::ServiceUnavailablewhen response returns status 503.EveOnline::Exceptions::Timeoutwhen timeout.
Timeouts
eve_online gem uses net/http for network request. net/http configured with:
http = Net::HTTP.new
http.read_timeout = 60
http.open_timeout = 60
You can configure default timeouts with adding read_timeout: and open_timeout: to default hash with options:
= { read_timeout: 120, open_timeout: 120 } # 120 seconds
races = EveOnline::ESI::Races.new()
Or, dynamically:
races = EveOnline::ESI::Races.new
races.open_timeout # => 60
races.open_timeout = 120
races.open_timeout # => 120
races.read_timeout # => 60
races.read_timeout = 120
races.read_timeout # => 120
Datasource
Default datasource is tranquility. If you want to change it, for e.g., to singularity, add datasource: 'singularity' to default hash with options:
= { datasource: 'singularity' }
races = EveOnline::ESI::Races.new()
Languages support
Default language is en-us. Supported languages: de, en-us, fr, ja, ru, zh.
If you want change it, for e.g., to de, add language: 'de' to default hash with options:
= { language: 'de' }
races = EveOnline::ESI::Races.new()
Oj as JSON Parser
require 'oj'
Oj.mimic_JSON()
races = EveOnline::ESI::Races.new
Useful links
- BREAKING CHANGES AND YOU - HOW TO USE ALT-ROUTES TO ENHANCE YOUR SANITY
- TECHNICAL NOTE: INTEGER SIZES AND THE XML API
- THE END OF PUBLIC CREST AS WE KNOW IT
- CCP, zKillboard (Eve-Kill), and your API
- JUMP CLONES, IMPLANTS, SKILLS, AND MORE
- ESI Swagger
Development
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Contributing
Issue reports and pull requests are welcome on GitHub at https://github.com/evemonk/eve_online.
Author
- Igor Zubkov (@biow0lf)
Contributors
Thank you everyone!
- Ian Flynn (@monban)
- Mekaret Eriker (@Mekaret)
License
The gem is available as open source under the terms of the MIT License.