Class: ESI::MarketApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-esi/api/market_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MarketApi

Returns a new instance of MarketApi.



16
17
18
 
# File 'lib/ruby-esi/api/market_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/ruby-esi/api/market_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id_orders(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdOrders200Ok>

List open orders from a character List open market orders placed by a character — Alternate route: ‘/dev/characters/character_id/orders/` Alternate route: `/v2/characters/character_id/orders/` — This route is cached for up to 1200 seconds

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



27
28
29
30
 
# File 'lib/ruby-esi/api/market_api.rb', line 27

def get_characters_character_id_orders(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_orders_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_orders_history(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdOrdersHistory200Ok>

List historical orders by a character List cancelled and expired market orders placed by a character up to 90 days in the past. — Alternate route: ‘/dev/characters/character_id/orders/history/` Alternate route: `/legacy/characters/character_id/orders/history/` Alternate route: `/v1/characters/character_id/orders/history/` — This route is cached for up to 3600 seconds

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



96
97
98
99
 
# File 'lib/ruby-esi/api/market_api.rb', line 96

def get_characters_character_id_orders_history(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_orders_history_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_orders_history_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdOrdersHistory200Ok>, Integer, Hash)>

List historical orders by a character List cancelled and expired market orders placed by a character up to 90 days in the past. — Alternate route: &#x60;/dev/characters/character_id/orders/history/&#x60; Alternate route: &#x60;/legacy/characters/character_id/orders/history/&#x60; Alternate route: &#x60;/v1/characters/character_id/orders/history/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return

  • :token (String) —

    Access token to use if unable to set a header

Returns:



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/ruby-esi/api/market_api.rb', line 110

def get_characters_character_id_orders_history_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MarketApi.get_characters_character_id_orders_history ...'
  end
  # verify the required parameter 'character_id' is set
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling MarketApi.get_characters_character_id_orders_history"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/characters/{character_id}/orders/history/'.sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = opts[: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?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetCharactersCharacterIdOrdersHistory200Ok>' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MarketApi#get_characters_character_id_orders_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_orders_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdOrders200Ok>, Integer, Hash)>

List open orders from a character List open market orders placed by a character — Alternate route: &#x60;/dev/characters/character_id/orders/&#x60; Alternate route: &#x60;/v2/characters/character_id/orders/&#x60; — This route is cached for up to 1200 seconds

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/ruby-esi/api/market_api.rb', line 40

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
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling MarketApi.get_characters_character_id_orders"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/characters/{character_id}/orders/'.sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetCharactersCharacterIdOrders200Ok>' 

  auth_names = opts[: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 => return_type)

  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_corporations_corporation_id_orders(corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdOrders200Ok>

List open orders from a corporation List open market orders placed on behalf of a corporation — Alternate route: ‘/dev/corporations/corporation_id/orders/` Alternate route: `/v3/corporations/corporation_id/orders/` — This route is cached for up to 1200 seconds — Requires one of the following EVE corporation role(s): Accountant, Trader

Parameters:

  • corporation_id —

    An EVE corporation ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



167
168
169
170
 
# File 'lib/ruby-esi/api/market_api.rb', line 167

def get_corporations_corporation_id_orders(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_orders_with_http_info(corporation_id, opts)
  data
end

#get_corporations_corporation_id_orders_history(corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdOrdersHistory200Ok>

List historical orders from a corporation List cancelled and expired market orders placed on behalf of a corporation up to 90 days in the past. — Alternate route: ‘/dev/corporations/corporation_id/orders/history/` Alternate route: `/v2/corporations/corporation_id/orders/history/` — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant, Trader

Parameters:

  • corporation_id —

    An EVE corporation ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



238
239
240
241
 
# File 'lib/ruby-esi/api/market_api.rb', line 238

def get_corporations_corporation_id_orders_history(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_orders_history_with_http_info(corporation_id, opts)
  data
end

#get_corporations_corporation_id_orders_history_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdOrdersHistory200Ok>, Integer, Hash)>

List historical orders from a corporation List cancelled and expired market orders placed on behalf of a corporation up to 90 days in the past. — Alternate route: &#x60;/dev/corporations/corporation_id/orders/history/&#x60; Alternate route: &#x60;/v2/corporations/corporation_id/orders/history/&#x60; — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant, Trader

Parameters:

  • corporation_id —

    An EVE corporation ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return

  • :token (String) —

    Access token to use if unable to set a header

Returns:



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/ruby-esi/api/market_api.rb', line 252

def get_corporations_corporation_id_orders_history_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MarketApi.get_corporations_corporation_id_orders_history ...'
  end
  # verify the required parameter 'corporation_id' is set
  if @api_client.config.client_side_validation && corporation_id.nil?
    fail ArgumentError, "Missing the required parameter 'corporation_id' when calling MarketApi.get_corporations_corporation_id_orders_history"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/corporations/{corporation_id}/orders/history/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s)

  # query parameters
  query_params = opts[: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?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetCorporationsCorporationIdOrdersHistory200Ok>' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MarketApi#get_corporations_corporation_id_orders_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporations_corporation_id_orders_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdOrders200Ok>, Integer, Hash)>

List open orders from a corporation List open market orders placed on behalf of a corporation — Alternate route: &#x60;/dev/corporations/corporation_id/orders/&#x60; Alternate route: &#x60;/v3/corporations/corporation_id/orders/&#x60; — This route is cached for up to 1200 seconds — Requires one of the following EVE corporation role(s): Accountant, Trader

Parameters:

  • corporation_id —

    An EVE corporation ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return

  • :token (String) —

    Access token to use if unable to set a header

Returns:



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/ruby-esi/api/market_api.rb', line 181

def get_corporations_corporation_id_orders_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MarketApi.get_corporations_corporation_id_orders ...'
  end
  # verify the required parameter 'corporation_id' is set
  if @api_client.config.client_side_validation && corporation_id.nil?
    fail ArgumentError, "Missing the required parameter 'corporation_id' when calling MarketApi.get_corporations_corporation_id_orders"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/corporations/{corporation_id}/orders/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s)

  # query parameters
  query_params = opts[: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?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetCorporationsCorporationIdOrders200Ok>' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MarketApi#get_corporations_corporation_id_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_markets_groups(opts = {}) ⇒ Array<Integer>

Get item groups Get a list of item groups — Alternate route: ‘/dev/markets/groups/` Alternate route: `/legacy/markets/groups/` Alternate route: `/v1/markets/groups/` — This route expires daily at 11:05

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

Returns:

  • (Array<Integer>) 


306
307
308
309
 
# File 'lib/ruby-esi/api/market_api.rb', line 306

def get_markets_groups(opts = {})
  data, _status_code, _headers = get_markets_groups_with_http_info(opts)
  data
end

#get_markets_groups_market_group_id(market_group_id, opts = {}) ⇒ GetMarketsGroupsMarketGroupIdOk

Get item group information Get information on an item group — Alternate route: ‘/dev/markets/groups/market_group_id/` Alternate route: `/legacy/markets/groups/market_group_id/` Alternate route: `/v1/markets/groups/market_group_id/` — This route expires daily at 11:05

Parameters:

  • market_group_id —

    An Eve item group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Language to use in the response (default to en)

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :language (String) —

    Language to use in the response, takes precedence over Accept-Language (default to en)

Returns:



368
369
370
371
 
# File 'lib/ruby-esi/api/market_api.rb', line 368

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)
  data
end

#get_markets_groups_market_group_id_with_http_info(market_group_id, opts = {}) ⇒ Array<(GetMarketsGroupsMarketGroupIdOk, Integer, Hash)>

Get item group information Get information on an item group — Alternate route: &#x60;/dev/markets/groups/market_group_id/&#x60; Alternate route: &#x60;/legacy/markets/groups/market_group_id/&#x60; Alternate route: &#x60;/v1/markets/groups/market_group_id/&#x60; — This route expires daily at 11:05

Parameters:

  • market_group_id —

    An Eve item group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Language to use in the response

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :language (String) —

    Language to use in the response, takes precedence over Accept-Language

Returns:



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/ruby-esi/api/market_api.rb', line 382

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
  if @api_client.config.client_side_validation && market_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'market_group_id' when calling MarketApi.get_markets_groups_market_group_id"
  end
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !['en', 'en-us', 'de', 'fr', 'ja', 'ru', 'zh', 'ko', 'es'].include?(opts[:'accept_language'])
    fail ArgumentError, 'invalid value for "accept_language", must be one of en, en-us, de, fr, ja, ru, zh, ko, es'
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  if @api_client.config.client_side_validation && opts[:'language'] && !['en', 'en-us', 'de', 'fr', 'ja', 'ru', 'zh', 'ko', 'es'].include?(opts[:'language'])
    fail ArgumentError, 'invalid value for "language", must be one of en, en-us, de, fr, ja, ru, zh, ko, es'
  end
  # resource path
  local_var_path = '/markets/groups/{market_group_id}/'.sub('{' + 'market_group_id' + '}', market_group_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'language'] = opts[:'language'] if !opts[:'language'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'GetMarketsGroupsMarketGroupIdOk' 

  auth_names = opts[: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 => return_type)

  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_markets_groups_with_http_info(opts = {}) ⇒ Array<(Array<Integer>, Integer, Hash)>

Get item groups Get a list of item groups — Alternate route: &#x60;/dev/markets/groups/&#x60; Alternate route: &#x60;/legacy/markets/groups/&#x60; Alternate route: &#x60;/v1/markets/groups/&#x60; — This route expires daily at 11:05

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

Returns:

  • (Array<(Array<Integer>, Integer, Hash)>) —

    Array<Integer> data, response status code and response headers



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/ruby-esi/api/market_api.rb', line 317

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 @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/markets/groups/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<Integer>' 

  auth_names = opts[: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 => return_type)

  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

#get_markets_prices(opts = {}) ⇒ Array<GetMarketsPrices200Ok>

List market prices Return a list of prices — Alternate route: ‘/dev/markets/prices/` Alternate route: `/legacy/markets/prices/` Alternate route: `/v1/markets/prices/` — This route is cached for up to 3600 seconds

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

Returns:



442
443
444
445
 
# File 'lib/ruby-esi/api/market_api.rb', line 442

def get_markets_prices(opts = {})
  data, _status_code, _headers = get_markets_prices_with_http_info(opts)
  data
end

#get_markets_prices_with_http_info(opts = {}) ⇒ Array<(Array<GetMarketsPrices200Ok>, Integer, Hash)>

List market prices Return a list of prices — Alternate route: &#x60;/dev/markets/prices/&#x60; Alternate route: &#x60;/legacy/markets/prices/&#x60; Alternate route: &#x60;/v1/markets/prices/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

Returns:

  • (Array<(Array<GetMarketsPrices200Ok>, Integer, Hash)>) —

    Array<GetMarketsPrices200Ok> data, response status code and response headers



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/ruby-esi/api/market_api.rb', line 453

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 @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/markets/prices/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetMarketsPrices200Ok>' 

  auth_names = opts[: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 => return_type)

  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

#get_markets_region_id_history(region_id, type_id, opts = {}) ⇒ Array<GetMarketsRegionIdHistory200Ok>

List historical market statistics in a region Return a list of historical market statistics for the specified type in a region — Alternate route: ‘/dev/markets/region_id/history/` Alternate route: `/legacy/markets/region_id/history/` Alternate route: `/v1/markets/region_id/history/` — This route expires daily at 11:05

Parameters:

  • region_id —

    Return statistics in this region

  • type_id —

    Return statistics for this type

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

Returns:



503
504
505
506
 
# File 'lib/ruby-esi/api/market_api.rb', line 503

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)
  data
end

#get_markets_region_id_history_with_http_info(region_id, type_id, opts = {}) ⇒ Array<(Array<GetMarketsRegionIdHistory200Ok>, Integer, Hash)>

List historical market statistics in a region Return a list of historical market statistics for the specified type in a region — Alternate route: &#x60;/dev/markets/region_id/history/&#x60; Alternate route: &#x60;/legacy/markets/region_id/history/&#x60; Alternate route: &#x60;/v1/markets/region_id/history/&#x60; — This route expires daily at 11:05

Parameters:

  • region_id —

    Return statistics in this region

  • type_id —

    Return statistics for this type

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

Returns:

  • (Array<(Array<GetMarketsRegionIdHistory200Ok>, Integer, Hash)>) —

    Array<GetMarketsRegionIdHistory200Ok> data, response status code and response headers



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/ruby-esi/api/market_api.rb', line 516

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
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling MarketApi.get_markets_region_id_history"
  end
  # verify the required parameter 'type_id' is set
  if @api_client.config.client_side_validation && type_id.nil?
    fail ArgumentError, "Missing the required parameter 'type_id' when calling MarketApi.get_markets_region_id_history"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/markets/{region_id}/history/'.sub('{' + 'region_id' + '}', region_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'type_id'] = type_id
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetMarketsRegionIdHistory200Ok>' 

  auth_names = opts[: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 => return_type)

  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

#get_markets_region_id_orders(order_type, region_id, opts = {}) ⇒ Array<GetMarketsRegionIdOrders200Ok>

List orders in a region Return a list of orders in a region — Alternate route: ‘/dev/markets/region_id/orders/` Alternate route: `/legacy/markets/region_id/orders/` Alternate route: `/v1/markets/region_id/orders/` — This route is cached for up to 300 seconds

Parameters:

  • 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

  • region_id —

    Return orders in this region

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :type_id (Integer) —

    Return orders only for this type

Returns:



577
578
579
580
 
# File 'lib/ruby-esi/api/market_api.rb', line 577

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)
  data
end

#get_markets_region_id_orders_with_http_info(order_type, region_id, opts = {}) ⇒ Array<(Array<GetMarketsRegionIdOrders200Ok>, Integer, Hash)>

List orders in a region Return a list of orders in a region — Alternate route: &#x60;/dev/markets/region_id/orders/&#x60; Alternate route: &#x60;/legacy/markets/region_id/orders/&#x60; Alternate route: &#x60;/v1/markets/region_id/orders/&#x60; — This route is cached for up to 300 seconds

Parameters:

  • 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

  • region_id —

    Return orders in this region

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return

  • :type_id (Integer) —

    Return orders only for this type

Returns:

  • (Array<(Array<GetMarketsRegionIdOrders200Ok>, Integer, Hash)>) —

    Array<GetMarketsRegionIdOrders200Ok> data, response status code and response headers



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/ruby-esi/api/market_api.rb', line 592

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
  if @api_client.config.client_side_validation && order_type.nil?
    fail ArgumentError, "Missing the required parameter 'order_type' when calling MarketApi.get_markets_region_id_orders"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['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
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling MarketApi.get_markets_region_id_orders"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/markets/{region_id}/orders/'.sub('{' + 'region_id' + '}', region_id.to_s)

  # query parameters
  query_params = opts[: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?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetMarketsRegionIdOrders200Ok>' 

  auth_names = opts[: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 => return_type)

  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

#get_markets_region_id_types(region_id, opts = {}) ⇒ Array<Integer>

List type IDs relevant to a market Return a list of type IDs that have active orders in the region, for efficient market indexing. — Alternate route: ‘/dev/markets/region_id/types/` Alternate route: `/legacy/markets/region_id/types/` Alternate route: `/v1/markets/region_id/types/` — This route is cached for up to 600 seconds

Parameters:

  • region_id —

    Return statistics in this region

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return (default to 1)

Returns:

  • (Array<Integer>) 


657
658
659
660
 
# File 'lib/ruby-esi/api/market_api.rb', line 657

def get_markets_region_id_types(region_id, opts = {})
  data, _status_code, _headers = get_markets_region_id_types_with_http_info(region_id, opts)
  data
end

#get_markets_region_id_types_with_http_info(region_id, opts = {}) ⇒ Array<(Array<Integer>, Integer, Hash)>

List type IDs relevant to a market Return a list of type IDs that have active orders in the region, for efficient market indexing. — Alternate route: &#x60;/dev/markets/region_id/types/&#x60; Alternate route: &#x60;/legacy/markets/region_id/types/&#x60; Alternate route: &#x60;/v1/markets/region_id/types/&#x60; — This route is cached for up to 600 seconds

Parameters:

  • region_id —

    Return statistics in this region

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return

Returns:

  • (Array<(Array<Integer>, Integer, Hash)>) —

    Array<Integer> data, response status code and response headers



670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'lib/ruby-esi/api/market_api.rb', line 670

def get_markets_region_id_types_with_http_info(region_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MarketApi.get_markets_region_id_types ...'
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling MarketApi.get_markets_region_id_types"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/markets/{region_id}/types/'.sub('{' + 'region_id' + '}', region_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<Integer>' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MarketApi#get_markets_region_id_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_markets_structures_structure_id(structure_id, opts = {}) ⇒ Array<GetMarketsStructuresStructureId200Ok>

List orders in a structure Return all orders in a structure — Alternate route: ‘/dev/markets/structures/structure_id/` Alternate route: `/legacy/markets/structures/structure_id/` Alternate route: `/v1/markets/structures/structure_id/` — This route is cached for up to 300 seconds

Parameters:

  • structure_id —

    Return orders in this structure

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



726
727
728
729
 
# File 'lib/ruby-esi/api/market_api.rb', line 726

def get_markets_structures_structure_id(structure_id, opts = {})
  data, _status_code, _headers = get_markets_structures_structure_id_with_http_info(structure_id, opts)
  data
end

#get_markets_structures_structure_id_with_http_info(structure_id, opts = {}) ⇒ Array<(Array<GetMarketsStructuresStructureId200Ok>, Integer, Hash)>

List orders in a structure Return all orders in a structure — Alternate route: &#x60;/dev/markets/structures/structure_id/&#x60; Alternate route: &#x60;/legacy/markets/structures/structure_id/&#x60; Alternate route: &#x60;/v1/markets/structures/structure_id/&#x60; — This route is cached for up to 300 seconds

Parameters:

  • structure_id —

    Return orders in this structure

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :page (Integer) —

    Which page of results to return

  • :token (String) —

    Access token to use if unable to set a header

Returns:



740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/ruby-esi/api/market_api.rb', line 740

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
  if @api_client.config.client_side_validation && structure_id.nil?
    fail ArgumentError, "Missing the required parameter 'structure_id' when calling MarketApi.get_markets_structures_structure_id"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/markets/structures/{structure_id}/'.sub('{' + 'structure_id' + '}', structure_id.to_s)

  # query parameters
  query_params = opts[: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?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<GetMarketsStructuresStructureId200Ok>' 

  auth_names = opts[: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 => return_type)

  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