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

Get All Economic Indices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



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

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

Get All Economic Indices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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



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

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
  # resource path
  local_var_path = "/indices/economic"

  # query parameters
  query_params = {}
  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

Get All SIC Indices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



78
79
80
81
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 78

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

Get All SIC Indices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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



88
89
90
91
92
93
94
95
96
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
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 88

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
  # resource path
  local_var_path = "/indices/sic"

  # query parameters
  query_params = {}
  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

Get All Stock Market Indices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



128
129
130
131
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 128

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

Get All Stock Market Indices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 138

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
  # resource path
  local_var_path = "/indices/stock_market"

  # query parameters
  query_params = {}
  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

Get an Economic Index by ID

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

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

    the optional parameters

Returns:



178
179
180
181
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 178

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

Get an Economic Index by ID

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



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

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

Get Economic Index Data Point (Number) Returns a numeric 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:

  • (Float) 


232
233
234
235
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 232

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

Get Economic Index Data Point (Number) Returns a numeric 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<(Float, Fixnum, Hash)>) —

    Float data, response status code and response headers



243
244
245
246
247
248
249
250
251
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
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 243

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

Get Economic Index Data Point (Text) 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) 


291
292
293
294
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 291

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

Get Economic Index Data Point (Text) 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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
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
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 302

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

Get Economic Index Historical Data Returns historical values for the given ‘tag` and 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

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)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



355
356
357
358
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 355

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

Get Economic Index Historical Data Returns historical values for the given &#x60;tag&#x60; and 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

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;

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



371
372
373
374
375
376
377
378
379
380
381
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
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 371

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
  # 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[:'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

Get an SIC Index by ID

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

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

    the optional parameters

Returns:



426
427
428
429
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 426

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

Get an SIC Index by ID

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



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 436

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

Get SIC Index Data Point (Number) 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) 


480
481
482
483
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 480

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

Get SIC Index Data Point (Number) 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



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 491

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

Get SIC Index Data Point (Text) 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) 


539
540
541
542
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 539

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

Get SIC Index Data Point (Text) 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



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 550

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

Get SIC Index Historical Data 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)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



603
604
605
606
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 603

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

Get SIC Index Historical Data 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;

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



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

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
  # 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[:'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

Get a Stock Market Index by ID

Parameters:

  • identifier —

    An Index Identifier (symbol, Intrinio ID)

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

    the optional parameters

Returns:



674
675
676
677
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 674

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

Get a Stock Market Index by ID

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



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
717
718
719
720
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 684

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

Get Stock Market Index Data Point (Number) 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) 


728
729
730
731
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 728

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

Get Stock Market Index Data Point (Number) 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



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

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

Get Stock Market Index Data Point (Text) 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) 


787
788
789
790
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 787

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

Get Stock Market Index Data Point (Text) 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



798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 798

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

Get Stock Market Index Historical Data 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)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



851
852
853
854
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 851

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

Get Stock Market Index Historical Data 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;

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 867

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
  # 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[:'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 = {}) ⇒ ApiResponseEconomicIndices

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

Parameters:

  • query —

    Search query

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

    the optional parameters

Returns:



922
923
924
925
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 922

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<(ApiResponseEconomicIndices, 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

Returns:

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

    ApiResponseEconomicIndices data, response status code and response headers



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
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 932

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
  # resource path
  local_var_path = "/indices/economic/search"

  # query parameters
  query_params = {}
  query_params[:'query'] = query

  # 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#search_economic_indices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

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

Parameters:

  • query —

    Search query

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

    the optional parameters

Returns:



976
977
978
979
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 976

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<(ApiResponseSICIndices, 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

Returns:

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

    ApiResponseSICIndices data, response status code and response headers



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
1019
1020
1021
1022
1023
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 986

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
  # resource path
  local_var_path = "/indices/sic/search"

  # query parameters
  query_params = {}
  query_params[:'query'] = query

  # 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#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 = {}) ⇒ ApiResponseStockMarketIndices

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

Parameters:

  • query —

    Search query

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

    the optional parameters

Returns:



1030
1031
1032
1033
 
# File 'lib/intrinio-sdk/api/index_api.rb', line 1030

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<(ApiResponseStockMarketIndices, 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

Returns:



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

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
  # resource path
  local_var_path = "/indices/stock_market/search"

  # query parameters
  query_params = {}
  query_params[:'query'] = query

  # 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#search_stock_markets_indices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end