Class: Intrinio::IndexApi

Inherits:
Object
  • Object
show all
Defined in:
lib/intrinio-sdk/api/index_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IndexApi

Returns a new instance of IndexApi.



19
20
21
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_all_economic_indices(opts = {}) ⇒ ApiResponseEconomicIndices

All Economic Indices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



29
30
31
32
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 29

def get_all_economic_indices(opts = {})
  data, _status_code, _headers = get_all_economic_indices_with_http_info(opts)
  return data
end

#get_all_economic_indices_with_http_info(opts = {}) ⇒ Array<(ApiResponseEconomicIndices, Fixnum, Hash)>

All Economic Indices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:

  • (Array<(ApiResponseEconomicIndices, Fixnum, Hash)>) —

    ApiResponseEconomicIndices data, response status code and response headers



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
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 40

def get_all_economic_indices_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.get_all_economic_indices ..."
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IndexApi.get_all_economic_indices, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/indices/economic"

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'ApiResponseEconomicIndices')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_all_economic_indices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_sic_indices(opts = {}) ⇒ ApiResponseSICIndices

All SIC Indices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



86
87
88
89
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 86

def get_all_sic_indices(opts = {})
  data, _status_code, _headers = get_all_sic_indices_with_http_info(opts)
  return data
end

#get_all_sic_indices_with_http_info(opts = {}) ⇒ Array<(ApiResponseSICIndices, Fixnum, Hash)>

All SIC Indices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:

  • (Array<(ApiResponseSICIndices, Fixnum, Hash)>) —

    ApiResponseSICIndices data, response status code and response headers



97
98
99
100
101
102
103
104
105
106
107
108
109
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
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 97

def get_all_sic_indices_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.get_all_sic_indices ..."
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IndexApi.get_all_sic_indices, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/indices/sic"

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'ApiResponseSICIndices')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_all_sic_indices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_stock_market_indices(opts = {}) ⇒ ApiResponseStockMarketIndices

All Stock Market Indices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



143
144
145
146
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 143

def get_all_stock_market_indices(opts = {})
  data, _status_code, _headers = get_all_stock_market_indices_with_http_info(opts)
  return data
end

#get_all_stock_market_indices_with_http_info(opts = {}) ⇒ Array<(ApiResponseStockMarketIndices, Fixnum, Hash)>

All Stock Market Indices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 154

def get_all_stock_market_indices_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.get_all_stock_market_indices ..."
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IndexApi.get_all_stock_market_indices, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/indices/stock_market"

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'ApiResponseStockMarketIndices')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_all_stock_market_indices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_economic_index_by_id(identifier, opts = {}) ⇒ EconomicIndex

Lookup Economic Index

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

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

    the optional parameters

Returns:



199
200
201
202
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 199

def get_economic_index_by_id(identifier, opts = {})
  data, _status_code, _headers = get_economic_index_by_id_with_http_info(identifier, opts)
  return data
end

#get_economic_index_by_id_with_http_info(identifier, opts = {}) ⇒ Array<(EconomicIndex, Fixnum, Hash)>

Lookup Economic Index

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

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

    the optional parameters

Returns:

  • (Array<(EconomicIndex, Fixnum, Hash)>) —

    EconomicIndex data, response status code and response headers



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 209

def get_economic_index_by_id_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.get_economic_index_by_id ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_economic_index_by_id"
  end
  # resource path
  local_var_path = "/indices/economic/{identifier}".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'EconomicIndex')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_economic_index_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_economic_index_data_point_number(identifier, tag, opts = {}) ⇒ Float

Data Point (Number) for an Economic Index Returns a numeric value for the given ‘tag` for the Economic Index with the given `identifier`

Parameters:

Returns:

  • (Float) 


253
254
255
256
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 253

def get_economic_index_data_point_number(identifier, tag, opts = {})
  data, _status_code, _headers = get_economic_index_data_point_number_with_http_info(identifier, tag, opts)
  return data
end

#get_economic_index_data_point_number_with_http_info(identifier, tag, opts = {}) ⇒ Array<(Float, Fixnum, Hash)>

Data Point (Number) for an Economic Index Returns a numeric value for the given &#x60;tag&#x60; for the Economic Index with the given &#x60;identifier&#x60;

Parameters:

Returns:

  • (Array<(Float, Fixnum, Hash)>) —

    Float data, response status code and response headers



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
300
301
302
303
304
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 264

def get_economic_index_data_point_number_with_http_info(identifier, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.get_economic_index_data_point_number ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_economic_index_data_point_number"
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_economic_index_data_point_number"
  end
  # resource path
  local_var_path = "/indices/economic/{identifier}/data_point/{tag}/number".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'Float')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_economic_index_data_point_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_economic_index_data_point_text(identifier, tag, opts = {}) ⇒ String

Data Point (Text) for an Economic Index Returns a text value for the given ‘tag` for the Economic Index with the given `identifier`

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Returns:

  • (String) 


312
313
314
315
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 312

def get_economic_index_data_point_text(identifier, tag, opts = {})
  data, _status_code, _headers = get_economic_index_data_point_text_with_http_info(identifier, tag, opts)
  return data
end

#get_economic_index_data_point_text_with_http_info(identifier, tag, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Data Point (Text) for an Economic Index Returns a text value for the given &#x60;tag&#x60; for the Economic Index with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
359
360
361
362
363
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 323

def get_economic_index_data_point_text_with_http_info(identifier, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.get_economic_index_data_point_text ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_economic_index_data_point_text"
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_economic_index_data_point_text"
  end
  # resource path
  local_var_path = "/indices/economic/{identifier}/data_point/{tag}/text".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_economic_index_data_point_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_economic_index_historical_data(identifier, tag, opts = {}) ⇒ ApiResponseEconomicIndexHistoricalData

Historical Data for an Economic Index Returns historical values for the given ‘tag` and the Economic Index with the given `identifier`

Parameters:

Options Hash (opts):

  • :type (String) —

    Filter by type, when applicable

  • :start_date (Date) —

    Get historical data on or after this date

  • :end_date (Date) —

    Get historical data on or before this date

  • :sort_order (String) —

    Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; (default to desc)

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



377
378
379
380
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 377

def get_economic_index_historical_data(identifier, tag, opts = {})
  data, _status_code, _headers = get_economic_index_historical_data_with_http_info(identifier, tag, opts)
  return data
end

#get_economic_index_historical_data_with_http_info(identifier, tag, opts = {}) ⇒ Array<(ApiResponseEconomicIndexHistoricalData, Fixnum, Hash)>

Historical Data for an Economic Index Returns historical values for the given &#x60;tag&#x60; and the Economic Index with the given &#x60;identifier&#x60;

Parameters:

Options Hash (opts):

  • :type (String) —

    Filter by type, when applicable

  • :start_date (Date) —

    Get historical data on or after this date

  • :end_date (Date) —

    Get historical data on or before this date

  • :sort_order (String) —

    Sort by date &#x60;asc&#x60; or &#x60;desc&#x60;

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



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
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 394

def get_economic_index_historical_data_with_http_info(identifier, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.get_economic_index_historical_data ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_economic_index_historical_data"
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_economic_index_historical_data"
  end
  if @api_client.config.client_side_validation && opts[:'sort_order'] && !['asc', 'desc'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of asc, desc'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IndexApi.get_economic_index_historical_data, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/indices/economic/{identifier}/historical_data/{tag}".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)

  # query parameters
  query_params = {}
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'ApiResponseEconomicIndexHistoricalData')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_economic_index_historical_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sic_index_by_id(identifier, opts = {}) ⇒ SICIndex

Lookup SIC Index

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

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

    the optional parameters

Returns:



454
455
456
457
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 454

def get_sic_index_by_id(identifier, opts = {})
  data, _status_code, _headers = get_sic_index_by_id_with_http_info(identifier, opts)
  return data
end

#get_sic_index_by_id_with_http_info(identifier, opts = {}) ⇒ Array<(SICIndex, Fixnum, Hash)>

Lookup SIC Index

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

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

    the optional parameters

Returns:

  • (Array<(SICIndex, Fixnum, Hash)>) —

    SICIndex data, response status code and response headers



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
495
496
497
498
499
500
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 464

def get_sic_index_by_id_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.get_sic_index_by_id ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_sic_index_by_id"
  end
  # resource path
  local_var_path = "/indices/sic/{identifier}".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'SICIndex')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_sic_index_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sic_index_data_point_number(identifier, tag, opts = {}) ⇒ Float

Data Point (Number) for an SIC Index Returns a numeric value for the given ‘tag` for the SIC Index with the given `identifier`

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Returns:

  • (Float) 


508
509
510
511
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 508

def get_sic_index_data_point_number(identifier, tag, opts = {})
  data, _status_code, _headers = get_sic_index_data_point_number_with_http_info(identifier, tag, opts)
  return data
end

#get_sic_index_data_point_number_with_http_info(identifier, tag, opts = {}) ⇒ Array<(Float, Fixnum, Hash)>

Data Point (Number) for an SIC Index Returns a numeric value for the given &#x60;tag&#x60; for the SIC Index with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Returns:

  • (Array<(Float, Fixnum, Hash)>) —

    Float data, response status code and response headers



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
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 519

def get_sic_index_data_point_number_with_http_info(identifier, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.get_sic_index_data_point_number ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_sic_index_data_point_number"
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_sic_index_data_point_number"
  end
  # resource path
  local_var_path = "/indices/sic/{identifier}/data_point/{tag}/number".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'Float')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_sic_index_data_point_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sic_index_data_point_text(identifier, tag, opts = {}) ⇒ String

Data Point (Text) for an SIC Index Returns a text value for the given ‘tag` for the SIC Index with the given `identifier`

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Returns:

  • (String) 


567
568
569
570
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 567

def get_sic_index_data_point_text(identifier, tag, opts = {})
  data, _status_code, _headers = get_sic_index_data_point_text_with_http_info(identifier, tag, opts)
  return data
end

#get_sic_index_data_point_text_with_http_info(identifier, tag, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Data Point (Text) for an SIC Index Returns a text value for the given &#x60;tag&#x60; for the SIC Index with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



578
579
580
581
582
583
584
585
586
587
588
589
590
591
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
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 578

def get_sic_index_data_point_text_with_http_info(identifier, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.get_sic_index_data_point_text ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_sic_index_data_point_text"
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_sic_index_data_point_text"
  end
  # resource path
  local_var_path = "/indices/sic/{identifier}/data_point/{tag}/text".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_sic_index_data_point_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sic_index_historical_data(identifier, tag, opts = {}) ⇒ ApiResponseSICIndexHistoricalData

Historical Data for an SIC Index Returns historical values for the given ‘tag` and the SIC Index with the given `identifier`

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Filter by type, when applicable

  • :start_date (Date) —

    Get historical data on or after this date

  • :end_date (Date) —

    Get historical data on or before this date

  • :sort_order (String) —

    Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; (default to desc)

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



632
633
634
635
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 632

def get_sic_index_historical_data(identifier, tag, opts = {})
  data, _status_code, _headers = get_sic_index_historical_data_with_http_info(identifier, tag, opts)
  return data
end

#get_sic_index_historical_data_with_http_info(identifier, tag, opts = {}) ⇒ Array<(ApiResponseSICIndexHistoricalData, Fixnum, Hash)>

Historical Data for an SIC Index Returns historical values for the given &#x60;tag&#x60; and the SIC Index with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Filter by type, when applicable

  • :start_date (Date) —

    Get historical data on or after this date

  • :end_date (Date) —

    Get historical data on or before this date

  • :sort_order (String) —

    Sort by date &#x60;asc&#x60; or &#x60;desc&#x60;

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
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
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 649

def get_sic_index_historical_data_with_http_info(identifier, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.get_sic_index_historical_data ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_sic_index_historical_data"
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_sic_index_historical_data"
  end
  if @api_client.config.client_side_validation && opts[:'sort_order'] && !['asc', 'desc'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of asc, desc'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IndexApi.get_sic_index_historical_data, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/indices/sic/{identifier}/historical_data/{tag}".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)

  # query parameters
  query_params = {}
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'ApiResponseSICIndexHistoricalData')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_sic_index_historical_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stock_market_index_by_id(identifier, opts = {}) ⇒ StockMarketIndex

Lookup Stock Market Index

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

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

    the optional parameters

Returns:



709
710
711
712
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 709

def get_stock_market_index_by_id(identifier, opts = {})
  data, _status_code, _headers = get_stock_market_index_by_id_with_http_info(identifier, opts)
  return data
end

#get_stock_market_index_by_id_with_http_info(identifier, opts = {}) ⇒ Array<(StockMarketIndex, Fixnum, Hash)>

Lookup Stock Market Index

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

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

    the optional parameters

Returns:

  • (Array<(StockMarketIndex, Fixnum, Hash)>) —

    StockMarketIndex data, response status code and response headers



719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 719

def get_stock_market_index_by_id_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.get_stock_market_index_by_id ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_stock_market_index_by_id"
  end
  # resource path
  local_var_path = "/indices/stock_market/{identifier}".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'StockMarketIndex')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_stock_market_index_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stock_market_index_data_point_number(identifier, tag, opts = {}) ⇒ Float

Data Point (Number) for Stock Market Index Returns a numeric value for the given ‘tag` for the Stock Market Index with the given `identifier`

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Returns:

  • (Float) 


763
764
765
766
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 763

def get_stock_market_index_data_point_number(identifier, tag, opts = {})
  data, _status_code, _headers = get_stock_market_index_data_point_number_with_http_info(identifier, tag, opts)
  return data
end

#get_stock_market_index_data_point_number_with_http_info(identifier, tag, opts = {}) ⇒ Array<(Float, Fixnum, Hash)>

Data Point (Number) for Stock Market Index Returns a numeric value for the given &#x60;tag&#x60; for the Stock Market Index with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Returns:

  • (Array<(Float, Fixnum, Hash)>) —

    Float data, response status code and response headers



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 774

def get_stock_market_index_data_point_number_with_http_info(identifier, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.get_stock_market_index_data_point_number ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_stock_market_index_data_point_number"
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_stock_market_index_data_point_number"
  end
  # resource path
  local_var_path = "/indices/stock_market/{identifier}/data_point/{tag}/number".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'Float')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_stock_market_index_data_point_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stock_market_index_data_point_text(identifier, tag, opts = {}) ⇒ String

Data Point (Text) for Stock Market Index Returns a text value for the given ‘tag` for the Stock Market Index with the given `identifier`

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Returns:

  • (String) 


822
823
824
825
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 822

def get_stock_market_index_data_point_text(identifier, tag, opts = {})
  data, _status_code, _headers = get_stock_market_index_data_point_text_with_http_info(identifier, tag, opts)
  return data
end

#get_stock_market_index_data_point_text_with_http_info(identifier, tag, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Data Point (Text) for Stock Market Index Returns a text value for the given &#x60;tag&#x60; for the Stock Market Index with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 833

def get_stock_market_index_data_point_text_with_http_info(identifier, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.get_stock_market_index_data_point_text ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_stock_market_index_data_point_text"
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_stock_market_index_data_point_text"
  end
  # resource path
  local_var_path = "/indices/stock_market/{identifier}/data_point/{tag}/text".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_stock_market_index_data_point_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stock_market_index_historical_data(identifier, tag, opts = {}) ⇒ ApiResponseStockMarketIndexHistoricalData

Historical Data for Stock Market Index Returns historical values for the given ‘tag` and the Stock Market Index with the given `identifier`

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Filter by type, when applicable

  • :start_date (Date) —

    Get historical data on or after this date

  • :end_date (Date) —

    Get historical data on or before this date

  • :sort_order (String) —

    Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; (default to desc)

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



887
888
889
890
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 887

def get_stock_market_index_historical_data(identifier, tag, opts = {})
  data, _status_code, _headers = get_stock_market_index_historical_data_with_http_info(identifier, tag, opts)
  return data
end

#get_stock_market_index_historical_data_with_http_info(identifier, tag, opts = {}) ⇒ Array<(ApiResponseStockMarketIndexHistoricalData, Fixnum, Hash)>

Historical Data for Stock Market Index Returns historical values for the given &#x60;tag&#x60; and the Stock Market Index with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Filter by type, when applicable

  • :start_date (Date) —

    Get historical data on or after this date

  • :end_date (Date) —

    Get historical data on or before this date

  • :sort_order (String) —

    Sort by date &#x60;asc&#x60; or &#x60;desc&#x60;

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 904

def get_stock_market_index_historical_data_with_http_info(identifier, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.get_stock_market_index_historical_data ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling IndexApi.get_stock_market_index_historical_data"
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling IndexApi.get_stock_market_index_historical_data"
  end
  if @api_client.config.client_side_validation && opts[:'sort_order'] && !['asc', 'desc'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of asc, desc'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IndexApi.get_stock_market_index_historical_data, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/indices/stock_market/{identifier}/historical_data/{tag}".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)

  # query parameters
  query_params = {}
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'ApiResponseStockMarketIndexHistoricalData')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_stock_market_index_historical_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_economic_indices(query, opts = {}) ⇒ ApiResponseEconomicIndicesSearch

Search Economic Indices Searches for indices using the text in ‘query`

Parameters:

  • query —

    Search query

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return (default to 100)

Returns:



965
966
967
968
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 965

def search_economic_indices(query, opts = {})
  data, _status_code, _headers = search_economic_indices_with_http_info(query, opts)
  return data
end

#search_economic_indices_with_http_info(query, opts = {}) ⇒ Array<(ApiResponseEconomicIndicesSearch, Fixnum, Hash)>

Search Economic Indices Searches for indices using the text in &#x60;query&#x60;

Parameters:

  • query —

    Search query

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return

Returns:



976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 976

def search_economic_indices_with_http_info(query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.search_economic_indices ..."
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling IndexApi.search_economic_indices"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IndexApi.search_economic_indices, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/indices/economic/search"

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'ApiResponseEconomicIndicesSearch')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#search_economic_indices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_sic_indices(query, opts = {}) ⇒ ApiResponseSICIndicesSearch

Search SIC Indices Searches for indices using the text in ‘query`

Parameters:

  • query —

    Search query

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return (default to 100)

Returns:



1026
1027
1028
1029
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 1026

def search_sic_indices(query, opts = {})
  data, _status_code, _headers = search_sic_indices_with_http_info(query, opts)
  return data
end

#search_sic_indices_with_http_info(query, opts = {}) ⇒ Array<(ApiResponseSICIndicesSearch, Fixnum, Hash)>

Search SIC Indices Searches for indices using the text in &#x60;query&#x60;

Parameters:

  • query —

    Search query

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return

Returns:



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 1037

def search_sic_indices_with_http_info(query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.search_sic_indices ..."
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling IndexApi.search_sic_indices"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IndexApi.search_sic_indices, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/indices/sic/search"

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'ApiResponseSICIndicesSearch')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#search_sic_indices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_stock_markets_indices(query, opts = {}) ⇒ ApiResponseStockMarketIndicesSearch

Search Stock Market Indices Searches for indices using the text in ‘query`

Parameters:

  • query —

    Search query

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return (default to 100)

Returns:



1087
1088
1089
1090
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 1087

def search_stock_markets_indices(query, opts = {})
  data, _status_code, _headers = search_stock_markets_indices_with_http_info(query, opts)
  return data
end

#search_stock_markets_indices_with_http_info(query, opts = {}) ⇒ Array<(ApiResponseStockMarketIndicesSearch, Fixnum, Hash)>

Search Stock Market Indices Searches for indices using the text in &#x60;query&#x60;

Parameters:

  • query —

    Search query

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return

Returns:



1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 1098

def search_stock_markets_indices_with_http_info(query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IndexApi.search_stock_markets_indices ..."
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling IndexApi.search_stock_markets_indices"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IndexApi.search_stock_markets_indices, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/indices/stock_market/search"

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'ApiResponseStockMarketIndicesSearch')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#search_stock_markets_indices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end