ESI::IndustryApi
All URIs are relative to https://esi.evetech.net
Method | HTTP request | Description |
---|---|---|
get_characters_character_id_industry_jobs | GET /v1/characters/character_id/industry/jobs/ | List character industry jobs |
get_characters_character_id_mining | GET /v1/characters/character_id/mining/ | Character mining ledger |
get_corporation_corporation_id_mining_extractions | GET /v1/corporation/corporation_id/mining/extractions/ | Moon extraction timers |
get_corporation_corporation_id_mining_observers | GET /v1/corporation/corporation_id/mining/observers/ | Corporation mining observers |
get_corporation_corporation_id_mining_observers_observer_id | GET /v1/corporation/corporation_id/mining/observers/observer_id/ | Observed corporation mining |
get_corporations_corporation_id_industry_jobs | GET /v1/corporations/corporation_id/industry/jobs/ | List corporation industry jobs |
get_industry_facilities | GET /v1/industry/facilities/ | List industry facilities |
get_industry_systems | GET /v1/industry/systems/ | List solar system cost indices |
get_characters_character_id_industry_jobs
Array<GetCharactersCharacterIdIndustryJobs200Ok> get_characters_character_id_industry_jobs(character_id, opts)
List character industry jobs
List industry jobs placed by a character --- This route is cached for up to 300 seconds
Example
# load the gem
require 'esi-client-bvv'
# setup authorization
ESI.configure do |config|
# Configure OAuth2 access token for authorization: evesso
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = ESI::IndustryApi.new
character_id = 56 # Integer | An EVE character ID
opts = {
datasource: "tranquility", # String | The server name you would like data from
if_none_match: "if_none_match_example", # String | ETag from a previous request. A 304 will be returned if this matches the current ETag
include_completed: true, # BOOLEAN | Whether to retrieve completed character industry jobs. Only includes jobs from the past 90 days
token: "token_example" # String | Access token to use if unable to set a header
}
begin
#List character industry jobs
result = api_instance.get_characters_character_id_industry_jobs(character_id, opts)
p result
rescue ESI::ApiError => e
puts "Exception when calling IndustryApi->get_characters_character_id_industry_jobs: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
character_id | Integer | An EVE character ID | |
datasource | String | The server name you would like data from | [optional] [default to tranquility] |
if_none_match | String | ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] |
include_completed | BOOLEAN | Whether to retrieve completed character industry jobs. Only includes jobs from the past 90 days | [optional] |
token | String | Access token to use if unable to set a header | [optional] |
Return type
Array<GetCharactersCharacterIdIndustryJobs200Ok>
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
get_characters_character_id_mining
Array<GetCharactersCharacterIdMining200Ok> get_characters_character_id_mining(character_id, opts)
Character mining ledger
Paginated record of all mining done by a character for the past 30 days --- This route is cached for up to 600 seconds
Example
# load the gem
require 'esi-client-bvv'
# setup authorization
ESI.configure do |config|
# Configure OAuth2 access token for authorization: evesso
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = ESI::IndustryApi.new
character_id = 56 # Integer | An EVE character ID
opts = {
datasource: "tranquility", # String | The server name you would like data from
if_none_match: "if_none_match_example", # String | ETag from a previous request. A 304 will be returned if this matches the current ETag
page: 1, # Integer | Which page of results to return
token: "token_example" # String | Access token to use if unable to set a header
}
begin
#Character mining ledger
result = api_instance.get_characters_character_id_mining(character_id, opts)
p result
rescue ESI::ApiError => e
puts "Exception when calling IndustryApi->get_characters_character_id_mining: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
character_id | Integer | An EVE character ID | |
datasource | String | The server name you would like data from | [optional] [default to tranquility] |
if_none_match | String | ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] |
page | Integer | Which page of results to return | [optional] [default to 1] |
token | String | Access token to use if unable to set a header | [optional] |
Return type
Array<GetCharactersCharacterIdMining200Ok>
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
get_corporation_corporation_id_mining_extractions
Array<GetCorporationCorporationIdMiningExtractions200Ok> get_corporation_corporation_id_mining_extractions(corporation_id, , opts)
Moon extraction timers
Extraction timers for all moon chunks being extracted by refineries belonging to a corporation. --- This route is cached for up to 1800 seconds --- Requires one of the following EVE corporation role(s): Station_Manager
Example
# load the gem
require 'esi-client-bvv'
# setup authorization
ESI.configure do |config|
# Configure OAuth2 access token for authorization: evesso
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = ESI::IndustryApi.new
corporation_id = 56 # Integer | An EVE corporation ID
opts = {
datasource: "tranquility", # String | The server name you would like data from
if_none_match: "if_none_match_example", # String | ETag from a previous request. A 304 will be returned if this matches the current ETag
page: 1, # Integer | Which page of results to return
token: "token_example" # String | Access token to use if unable to set a header
}
begin
#Moon extraction timers
result = api_instance.get_corporation_corporation_id_mining_extractions(corporation_id, , opts)
p result
rescue ESI::ApiError => e
puts "Exception when calling IndustryApi->get_corporation_corporation_id_mining_extractions: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
corporation_id | Integer | An EVE corporation ID | |
datasource | String | The server name you would like data from | [optional] [default to tranquility] |
if_none_match | String | ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] |
page | Integer | Which page of results to return | [optional] [default to 1] |
token | String | Access token to use if unable to set a header | [optional] |
Return type
Array<GetCorporationCorporationIdMiningExtractions200Ok>
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
get_corporation_corporation_id_mining_observers
Array<GetCorporationCorporationIdMiningObservers200Ok> get_corporation_corporation_id_mining_observers(corporation_id, , opts)
Corporation mining observers
Paginated list of all entities capable of observing and recording mining for a corporation --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant
Example
# load the gem
require 'esi-client-bvv'
# setup authorization
ESI.configure do |config|
# Configure OAuth2 access token for authorization: evesso
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = ESI::IndustryApi.new
corporation_id = 56 # Integer | An EVE corporation ID
opts = {
datasource: "tranquility", # String | The server name you would like data from
if_none_match: "if_none_match_example", # String | ETag from a previous request. A 304 will be returned if this matches the current ETag
page: 1, # Integer | Which page of results to return
token: "token_example" # String | Access token to use if unable to set a header
}
begin
#Corporation mining observers
result = api_instance.get_corporation_corporation_id_mining_observers(corporation_id, , opts)
p result
rescue ESI::ApiError => e
puts "Exception when calling IndustryApi->get_corporation_corporation_id_mining_observers: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
corporation_id | Integer | An EVE corporation ID | |
datasource | String | The server name you would like data from | [optional] [default to tranquility] |
if_none_match | String | ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] |
page | Integer | Which page of results to return | [optional] [default to 1] |
token | String | Access token to use if unable to set a header | [optional] |
Return type
Array<GetCorporationCorporationIdMiningObservers200Ok>
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
get_corporation_corporation_id_mining_observers_observer_id
Array<GetCorporationCorporationIdMiningObserversObserverId200Ok> get_corporation_corporation_id_mining_observers_observer_id(corporation_id, observer_id, opts)
Observed corporation mining
Paginated record of all mining seen by an observer --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant
Example
# load the gem
require 'esi-client-bvv'
# setup authorization
ESI.configure do |config|
# Configure OAuth2 access token for authorization: evesso
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = ESI::IndustryApi.new
corporation_id = 56 # Integer | An EVE corporation ID
observer_id = 789 # Integer | A mining observer id
opts = {
datasource: "tranquility", # String | The server name you would like data from
if_none_match: "if_none_match_example", # String | ETag from a previous request. A 304 will be returned if this matches the current ETag
page: 1, # Integer | Which page of results to return
token: "token_example" # String | Access token to use if unable to set a header
}
begin
#Observed corporation mining
result = api_instance.get_corporation_corporation_id_mining_observers_observer_id(corporation_id, observer_id, opts)
p result
rescue ESI::ApiError => e
puts "Exception when calling IndustryApi->get_corporation_corporation_id_mining_observers_observer_id: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
corporation_id | Integer | An EVE corporation ID | |
observer_id | Integer | A mining observer id | |
datasource | String | The server name you would like data from | [optional] [default to tranquility] |
if_none_match | String | ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] |
page | Integer | Which page of results to return | [optional] [default to 1] |
token | String | Access token to use if unable to set a header | [optional] |
Return type
Array<GetCorporationCorporationIdMiningObserversObserverId200Ok>
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
get_corporations_corporation_id_industry_jobs
Array<GetCorporationsCorporationIdIndustryJobs200Ok> get_corporations_corporation_id_industry_jobs(corporation_id, , opts)
List corporation industry jobs
List industry jobs run by a corporation --- This route is cached for up to 300 seconds --- Requires one of the following EVE corporation role(s): Factory_Manager
Example
# load the gem
require 'esi-client-bvv'
# setup authorization
ESI.configure do |config|
# Configure OAuth2 access token for authorization: evesso
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = ESI::IndustryApi.new
corporation_id = 56 # Integer | An EVE corporation ID
opts = {
datasource: "tranquility", # String | The server name you would like data from
if_none_match: "if_none_match_example", # String | ETag from a previous request. A 304 will be returned if this matches the current ETag
include_completed: false, # BOOLEAN | Whether to retrieve completed corporation industry jobs. Only includes jobs from the past 90 days
page: 1, # Integer | Which page of results to return
token: "token_example" # String | Access token to use if unable to set a header
}
begin
#List corporation industry jobs
result = api_instance.get_corporations_corporation_id_industry_jobs(corporation_id, , opts)
p result
rescue ESI::ApiError => e
puts "Exception when calling IndustryApi->get_corporations_corporation_id_industry_jobs: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
corporation_id | Integer | An EVE corporation ID | |
datasource | String | The server name you would like data from | [optional] [default to tranquility] |
if_none_match | String | ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] |
include_completed | BOOLEAN | Whether to retrieve completed corporation industry jobs. Only includes jobs from the past 90 days | [optional] [default to false] |
page | Integer | Which page of results to return | [optional] [default to 1] |
token | String | Access token to use if unable to set a header | [optional] |
Return type
Array<GetCorporationsCorporationIdIndustryJobs200Ok>
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
get_industry_facilities
Array<GetIndustryFacilities200Ok> get_industry_facilities(opts)
List industry facilities
Return a list of industry facilities --- This route is cached for up to 3600 seconds
Example
# load the gem
require 'esi-client-bvv'
api_instance = ESI::IndustryApi.new
opts = {
datasource: "tranquility", # String | The server name you would like data from
if_none_match: "if_none_match_example", # String | ETag from a previous request. A 304 will be returned if this matches the current ETag
}
begin
#List industry facilities
result = api_instance.get_industry_facilities(opts)
p result
rescue ESI::ApiError => e
puts "Exception when calling IndustryApi->get_industry_facilities: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datasource | String | The server name you would like data from | [optional] [default to tranquility] |
if_none_match | String | ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] |
Return type
Array<GetIndustryFacilities200Ok>
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
get_industry_systems
Array<GetIndustrySystems200Ok> get_industry_systems(opts)
List solar system cost indices
Return cost indices for solar systems --- This route is cached for up to 3600 seconds
Example
# load the gem
require 'esi-client-bvv'
api_instance = ESI::IndustryApi.new
opts = {
datasource: "tranquility", # String | The server name you would like data from
if_none_match: "if_none_match_example", # String | ETag from a previous request. A 304 will be returned if this matches the current ETag
}
begin
#List solar system cost indices
result = api_instance.get_industry_systems(opts)
p result
rescue ESI::ApiError => e
puts "Exception when calling IndustryApi->get_industry_systems: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datasource | String | The server name you would like data from | [optional] [default to tranquility] |
if_none_match | String | ETag from a previous request. A 304 will be returned if this matches the current ETag | [optional] |
Return type
Array<GetIndustrySystems200Ok>
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json