class EsiClient::MarketApi
Attributes
Public Class Methods
# File lib/esi-ruby/api/market_api.rb, line 18 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
List orders from a character List market orders placed by a character — Alternate route: `/v1/characters/{character_id}/orders/` Alternate route: `/legacy/characters/{character_id}/orders/` Alternate route: `/dev/characters/{character_id}/orders/` — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetCharactersCharacterIdOrders200Ok>]
# File lib/esi-ruby/api/market_api.rb, line 31 def get_characters_character_id_orders(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_orders_with_http_info(character_id, opts) return data end
List orders from a character List market orders placed by a character — Alternate route: `/v1/characters/{character_id}/orders/` Alternate route: `/legacy/characters/{character_id}/orders/` Alternate route: `/dev/characters/{character_id}/orders/` — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetCharactersCharacterIdOrders200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdOrders200Ok> data, response status code and response headers
# File lib/esi-ruby/api/market_api.rb, line 45 def get_characters_character_id_orders_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MarketApi.get_characters_character_id_orders ..." end # verify the required parameter 'character_id' is set fail ArgumentError, "Missing the required parameter 'character_id' when calling MarketApi.get_characters_character_id_orders" if character_id.nil? if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/characters/{character_id}/orders/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetCharactersCharacterIdOrders200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: MarketApi#get_characters_character_id_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get item groups Get a list of item groups — Alternate route: `/v1/markets/groups/` Alternate route: `/legacy/markets/groups/` Alternate route: `/dev/markets/groups/` — This route expires daily at 11:05 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<Integer>]
# File lib/esi-ruby/api/market_api.rb, line 95 def get_markets_groups(opts = {}) data, _status_code, _headers = get_markets_groups_with_http_info(opts) return data end
Get item group information Get information on an item group — Alternate route: `/v1/markets/groups/{market_group_id}/` Alternate route: `/legacy/markets/groups/{market_group_id}/` Alternate route: `/dev/markets/groups/{market_group_id}/` — This route expires daily at 11:05 @param market_group_id An Eve item group ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :language Language to use in the response (default to en-us) @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [GetMarketsGroupsMarketGroupIdOk]
# File lib/esi-ruby/api/market_api.rb, line 156 def get_markets_groups_market_group_id(market_group_id, opts = {}) data, _status_code, _headers = get_markets_groups_market_group_id_with_http_info(market_group_id, opts) return data end
Get item group information Get information on an item group — Alternate route: `/v1/markets/groups/{market_group_id}/` Alternate route: `/legacy/markets/groups/{market_group_id}/` Alternate route: `/dev/markets/groups/{market_group_id}/` — This route expires daily at 11:05 @param market_group_id An Eve item group ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :language Language to use in the response @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(GetMarketsGroupsMarketGroupIdOk
, Fixnum, Hash)>] GetMarketsGroupsMarketGroupIdOk
data, response status code and response headers
# File lib/esi-ruby/api/market_api.rb, line 170 def get_markets_groups_market_group_id_with_http_info(market_group_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MarketApi.get_markets_groups_market_group_id ..." end # verify the required parameter 'market_group_id' is set fail ArgumentError, "Missing the required parameter 'market_group_id' when calling MarketApi.get_markets_groups_market_group_id" if market_group_id.nil? if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end if opts[:'language'] && !['de', 'en-us', 'fr', 'ja', 'ru', 'zh'].include?(opts[:'language']) fail ArgumentError, 'invalid value for "language", must be one of de, en-us, fr, ja, ru, zh' end # resource path local_var_path = "/markets/groups/{market_group_id}/".sub('{format}','json').sub('{' + 'market_group_id' + '}', market_group_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'language'] = opts[:'language'] if !opts[:'language'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'GetMarketsGroupsMarketGroupIdOk') if @api_client.config.debugging @api_client.config.logger.debug "API called: MarketApi#get_markets_groups_market_group_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get item groups Get a list of item groups — Alternate route: `/v1/markets/groups/` Alternate route: `/legacy/markets/groups/` Alternate route: `/dev/markets/groups/` — This route expires daily at 11:05 @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<Integer>, Fixnum, Hash)>] Array<Integer> data, response status code and response headers
# File lib/esi-ruby/api/market_api.rb, line 107 def get_markets_groups_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MarketApi.get_markets_groups ..." end if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/markets/groups/".sub('{format}','json') # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<Integer>') if @api_client.config.debugging @api_client.config.logger.debug "API called: MarketApi#get_markets_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List market prices Return a list of prices — Alternate route: `/v1/markets/prices/` Alternate route: `/legacy/markets/prices/` Alternate route: `/dev/markets/prices/` — This route is cached for up to 3600 seconds @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetMarketsPrices200Ok>]
# File lib/esi-ruby/api/market_api.rb, line 223 def get_markets_prices(opts = {}) data, _status_code, _headers = get_markets_prices_with_http_info(opts) return data end
List market prices Return a list of prices — Alternate route: `/v1/markets/prices/` Alternate route: `/legacy/markets/prices/` Alternate route: `/dev/markets/prices/` — This route is cached for up to 3600 seconds @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetMarketsPrices200Ok>, Fixnum, Hash)>] Array<GetMarketsPrices200Ok> data, response status code and response headers
# File lib/esi-ruby/api/market_api.rb, line 235 def get_markets_prices_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MarketApi.get_markets_prices ..." end if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/markets/prices/".sub('{format}','json') # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetMarketsPrices200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: MarketApi#get_markets_prices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List historical market statistics in a region Return a list of historical market statistics for the specified type in a region — Alternate route: `/v1/markets/{region_id}/history/` Alternate route: `/legacy/markets/{region_id}/history/` Alternate route: `/dev/markets/{region_id}/history/` — This route is cached for up to 3600 seconds @param region_id Return statistics in this region @param type_id Return statistics for this type @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetMarketsRegionIdHistory200Ok>]
# File lib/esi-ruby/api/market_api.rb, line 284 def get_markets_region_id_history(region_id, type_id, opts = {}) data, _status_code, _headers = get_markets_region_id_history_with_http_info(region_id, type_id, opts) return data end
List historical market statistics in a region Return a list of historical market statistics for the specified type in a region — Alternate route: `/v1/markets/{region_id}/history/` Alternate route: `/legacy/markets/{region_id}/history/` Alternate route: `/dev/markets/{region_id}/history/` — This route is cached for up to 3600 seconds @param region_id Return statistics in this region @param type_id Return statistics for this type @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetMarketsRegionIdHistory200Ok>, Fixnum, Hash)>] Array<GetMarketsRegionIdHistory200Ok> data, response status code and response headers
# File lib/esi-ruby/api/market_api.rb, line 298 def get_markets_region_id_history_with_http_info(region_id, type_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MarketApi.get_markets_region_id_history ..." end # verify the required parameter 'region_id' is set fail ArgumentError, "Missing the required parameter 'region_id' when calling MarketApi.get_markets_region_id_history" if region_id.nil? # verify the required parameter 'type_id' is set fail ArgumentError, "Missing the required parameter 'type_id' when calling MarketApi.get_markets_region_id_history" if type_id.nil? if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/markets/{region_id}/history/".sub('{format}','json').sub('{' + 'region_id' + '}', region_id.to_s) # query parameters query_params = {} query_params[:'type_id'] = type_id query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetMarketsRegionIdHistory200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: MarketApi#get_markets_region_id_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List orders in a region Return a list of orders in a region — Alternate route: `/v1/markets/{region_id}/orders/` Alternate route: `/legacy/markets/{region_id}/orders/` Alternate route: `/dev/markets/{region_id}/orders/` — This route is cached for up to 300 seconds @param order_type Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders. @param region_id Return orders in this region @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [Integer] :page Which page of results to return (default to 1) @option opts [Integer] :type_id Return orders only for this type @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetMarketsRegionIdOrders200Ok>]
# File lib/esi-ruby/api/market_api.rb, line 354 def get_markets_region_id_orders(order_type, region_id, opts = {}) data, _status_code, _headers = get_markets_region_id_orders_with_http_info(order_type, region_id, opts) return data end
List orders in a region Return a list of orders in a region — Alternate route: `/v1/markets/{region_id}/orders/` Alternate route: `/legacy/markets/{region_id}/orders/` Alternate route: `/dev/markets/{region_id}/orders/` — This route is cached for up to 300 seconds @param order_type Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders. @param region_id Return orders in this region @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [Integer] :page Which page of results to return @option opts [Integer] :type_id Return orders only for this type @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetMarketsRegionIdOrders200Ok>, Fixnum, Hash)>] Array<GetMarketsRegionIdOrders200Ok> data, response status code and response headers
# File lib/esi-ruby/api/market_api.rb, line 370 def get_markets_region_id_orders_with_http_info(order_type, region_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MarketApi.get_markets_region_id_orders ..." end # verify the required parameter 'order_type' is set fail ArgumentError, "Missing the required parameter 'order_type' when calling MarketApi.get_markets_region_id_orders" if order_type.nil? # verify enum value unless ['buy', 'sell', 'all'].include?(order_type) fail ArgumentError, "invalid value for 'order_type', must be one of buy, sell, all" end # verify the required parameter 'region_id' is set fail ArgumentError, "Missing the required parameter 'region_id' when calling MarketApi.get_markets_region_id_orders" if region_id.nil? if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/markets/{region_id}/orders/".sub('{format}','json').sub('{' + 'region_id' + '}', region_id.to_s) # query parameters query_params = {} query_params[:'order_type'] = order_type query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'type_id'] = opts[:'type_id'] if !opts[:'type_id'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetMarketsRegionIdOrders200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: MarketApi#get_markets_region_id_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List orders in a structure Return all orders in a structure — Alternate route: `/v1/markets/structures/{structure_id}/` Alternate route: `/legacy/markets/structures/{structure_id}/` Alternate route: `/dev/markets/structures/{structure_id}/` — This route is cached for up to 300 seconds @param structure_id Return orders in this structure @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [Integer] :page Which page of results to return (default to 1) @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetMarketsStructuresStructureId200Ok>]
# File lib/esi-ruby/api/market_api.rb, line 431 def get_markets_structures_structure_id(structure_id, opts = {}) data, _status_code, _headers = get_markets_structures_structure_id_with_http_info(structure_id, opts) return data end
List orders in a structure Return all orders in a structure — Alternate route: `/v1/markets/structures/{structure_id}/` Alternate route: `/legacy/markets/structures/{structure_id}/` Alternate route: `/dev/markets/structures/{structure_id}/` — This route is cached for up to 300 seconds @param structure_id Return orders in this structure @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [Integer] :page Which page of results to return @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetMarketsStructuresStructureId200Ok>, Fixnum, Hash)>] Array<GetMarketsStructuresStructureId200Ok> data, response status code and response headers
# File lib/esi-ruby/api/market_api.rb, line 446 def get_markets_structures_structure_id_with_http_info(structure_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MarketApi.get_markets_structures_structure_id ..." end # verify the required parameter 'structure_id' is set fail ArgumentError, "Missing the required parameter 'structure_id' when calling MarketApi.get_markets_structures_structure_id" if structure_id.nil? if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = "/markets/structures/{structure_id}/".sub('{format}','json').sub('{' + 'structure_id' + '}', structure_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetMarketsStructuresStructureId200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: MarketApi#get_markets_structures_structure_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end