Class: Intrinio::CompanyApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CompanyApi

Returns a new instance of CompanyApi.



19
20
21
 
# File 'lib/intrinio-sdk/api/company_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/company_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_all_companies(opts = {}) ⇒ ApiResponseCompanies

All Companies Returns all Companies. When parameters are specified, returns matching companies.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :latest_filing_date (Date) —

    Return companies whose latest 10-Q or 10-K was filed on or after this date

  • :sic (String) —

    Return companies with the given Standard Industrial Classification code

  • :template (String) —

    Return companies with the given financial statement template

  • :sector (String) —

    Return companies in the given industry sector

  • :industry_category (String) —

    Return companies in the given industry category

  • :industry_group (String) —

    Return companies in the given industry group

  • :has_fundamentals (BOOLEAN) —

    Return only companies that have fundamentals when true

  • :has_stock_prices (BOOLEAN) —

    Return only companies that have stock prices when true

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



37
38
39
40
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 37

def get_all_companies(opts = {})
  data, _status_code, _headers = get_all_companies_with_http_info(opts)
  return data
end

#get_all_companies_with_http_info(opts = {}) ⇒ Array<(ApiResponseCompanies, Fixnum, Hash)>

All Companies Returns all Companies. When parameters are specified, returns matching companies.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :latest_filing_date (Date) —

    Return companies whose latest 10-Q or 10-K was filed on or after this date

  • :sic (String) —

    Return companies with the given Standard Industrial Classification code

  • :template (String) —

    Return companies with the given financial statement template

  • :sector (String) —

    Return companies in the given industry sector

  • :industry_category (String) —

    Return companies in the given industry category

  • :industry_group (String) —

    Return companies in the given industry group

  • :has_fundamentals (BOOLEAN) —

    Return only companies that have fundamentals when true

  • :has_stock_prices (BOOLEAN) —

    Return only companies that have stock prices when true

  • :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<(ApiResponseCompanies, Fixnum, Hash)>) —

    ApiResponseCompanies data, response status code and response headers



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 56

def get_all_companies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyApi.get_all_companies ..."
  end
  if @api_client.config.client_side_validation && opts[:'template'] && !['industrial', 'financial'].include?(opts[:'template'])
    fail ArgumentError, 'invalid value for "template", must be one of industrial, financial'
  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 CompanyApi.get_all_companies, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/companies"

  # query parameters
  query_params = {}
  query_params[:'latest_filing_date'] = opts[:'latest_filing_date'] if !opts[:'latest_filing_date'].nil?
  query_params[:'sic'] = opts[:'sic'] if !opts[:'sic'].nil?
  query_params[:'template'] = opts[:'template'] if !opts[:'template'].nil?
  query_params[:'sector'] = opts[:'sector'] if !opts[:'sector'].nil?
  query_params[:'industry_category'] = opts[:'industry_category'] if !opts[:'industry_category'].nil?
  query_params[:'industry_group'] = opts[:'industry_group'] if !opts[:'industry_group'].nil?
  query_params[:'has_fundamentals'] = opts[:'has_fundamentals'] if !opts[:'has_fundamentals'].nil?
  query_params[:'has_stock_prices'] = opts[:'has_stock_prices'] if !opts[:'has_stock_prices'].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 => 'ApiResponseCompanies')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanyApi#get_all_companies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_company_news(opts = {}) ⇒ ApiResponseNews

All News Returns all News for all Companies

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:



113
114
115
116
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 113

def get_all_company_news(opts = {})
  data, _status_code, _headers = get_all_company_news_with_http_info(opts)
  return data
end

#get_all_company_news_with_http_info(opts = {}) ⇒ Array<(ApiResponseNews, Fixnum, Hash)>

All News Returns all News for all Companies

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<(ApiResponseNews, Fixnum, Hash)>) —

    ApiResponseNews data, response status code and response headers



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 124

def get_all_company_news_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyApi.get_all_company_news ..."
  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 CompanyApi.get_all_company_news, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/companies/news"

  # 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 => 'ApiResponseNews')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanyApi#get_all_company_news\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_company(identifier, opts = {}) ⇒ Company

Lookup Company Returns the Company with the given ‘identifier`

Parameters:

  • identifier —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

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

    the optional parameters

Returns:



169
170
171
172
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 169

def get_company(identifier, opts = {})
  data, _status_code, _headers = get_company_with_http_info(identifier, opts)
  return data
end

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

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

Parameters:

Returns:

  • (Float) 


223
224
225
226
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 223

def get_company_data_point_number(identifier, tag, opts = {})
  data, _status_code, _headers = get_company_data_point_number_with_http_info(identifier, tag, opts)
  return data
end

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

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

Parameters:

Returns:

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

    Float data, response status code and response headers



234
235
236
237
238
239
240
241
242
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
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 234

def get_company_data_point_number_with_http_info(identifier, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyApi.get_company_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 CompanyApi.get_company_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 CompanyApi.get_company_data_point_number"
  end
  # resource path
  local_var_path = "/companies/{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: CompanyApi#get_company_data_point_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

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

Parameters:

Returns:

  • (String) 


282
283
284
285
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 282

def get_company_data_point_text(identifier, tag, opts = {})
  data, _status_code, _headers = get_company_data_point_text_with_http_info(identifier, tag, opts)
  return data
end

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

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

Parameters:

Returns:

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

    String data, response status code and response headers



293
294
295
296
297
298
299
300
301
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
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 293

def get_company_data_point_text_with_http_info(identifier, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyApi.get_company_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 CompanyApi.get_company_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 CompanyApi.get_company_data_point_text"
  end
  # resource path
  local_var_path = "/companies/{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: CompanyApi#get_company_data_point_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_company_filings(identifier, opts = {}) ⇒ ApiResponseCompanyFilings

All Filings by Company Returns a complete list of SEC filings for the Company with the given ‘identifier`

Parameters:

  • identifier —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

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

    the optional parameters

Options Hash (opts):

  • :report_type (String) —

    Filter by &lt;a href&#x3D;&quot;docs.intrinio.com/documentation/sec_filing_report_types&quot; target&#x3D;&quot;_blank&quot;&gt;report type&lt;/a&gt;. Separate values with commas to return multiple report types.

  • :start_date (Date) —

    Filed on or after the given date

  • :end_date (Date) —

    Filed before or after the given date

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



345
346
347
348
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 345

def get_company_filings(identifier, opts = {})
  data, _status_code, _headers = get_company_filings_with_http_info(identifier, opts)
  return data
end

#get_company_filings_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseCompanyFilings, Fixnum, Hash)>

All Filings by Company Returns a complete list of SEC filings for the Company with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

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

    the optional parameters

Options Hash (opts):

  • :report_type (String) —

    Filter by &lt;a href&#x3D;&quot;docs.intrinio.com/documentation/sec_filing_report_types&quot; target&#x3D;&quot;_blank&quot;&gt;report type&lt;/a&gt;. Separate values with commas to return multiple report types.

  • :start_date (Date) —

    Filed on or after the given date

  • :end_date (Date) —

    Filed before or after the given date

  • :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<(ApiResponseCompanyFilings, Fixnum, Hash)>) —

    ApiResponseCompanyFilings data, response status code and response headers



360
361
362
363
364
365
366
367
368
369
370
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
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 360

def get_company_filings_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyApi.get_company_filings ..."
  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 CompanyApi.get_company_filings"
  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 CompanyApi.get_company_filings, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/companies/{identifier}/filings".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'report_type'] = opts[:'report_type'] if !opts[:'report_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[:'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 => 'ApiResponseCompanyFilings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanyApi#get_company_filings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_company_fundamentals(identifier, opts = {}) ⇒ ApiResponseCompanyFundamentals

All Fundamentals by Company Returns all Fundamentals for the Company with the given ‘identifier`. Returns Fundamentals matching parameters when supplied.

Parameters:

  • identifier —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

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

    the optional parameters

Options Hash (opts):

  • :filed_after (Date) —

    Filed on or after this date

  • :filed_before (Date) —

    Filed on or before this date

  • :reported_only (BOOLEAN) —

    Only as-reported fundamentals

  • :fiscal_year (Integer) —

    Only for the given fiscal year

  • :statement_code (String) —

    Only of the given statement code

  • :type (String) —

    Only of the given type

  • :start_date (Date) —

    Only on or after the given date

  • :end_date (Date) —

    Only on or before the given date

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



422
423
424
425
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 422

def get_company_fundamentals(identifier, opts = {})
  data, _status_code, _headers = get_company_fundamentals_with_http_info(identifier, opts)
  return data
end

#get_company_fundamentals_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseCompanyFundamentals, Fixnum, Hash)>

All Fundamentals by Company Returns all Fundamentals for the Company with the given &#x60;identifier&#x60;. Returns Fundamentals matching parameters when supplied.

Parameters:

  • identifier —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

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

    the optional parameters

Options Hash (opts):

  • :filed_after (Date) —

    Filed on or after this date

  • :filed_before (Date) —

    Filed on or before this date

  • :reported_only (BOOLEAN) —

    Only as-reported fundamentals

  • :fiscal_year (Integer) —

    Only for the given fiscal year

  • :statement_code (String) —

    Only of the given statement code

  • :type (String) —

    Only of the given type

  • :start_date (Date) —

    Only on or after the given date

  • :end_date (Date) —

    Only on or before the given date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



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

def get_company_fundamentals_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyApi.get_company_fundamentals ..."
  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 CompanyApi.get_company_fundamentals"
  end
  if @api_client.config.client_side_validation && opts[:'statement_code'] && !['income_statement', 'balance_sheet_statement', 'cash_flow_statement', 'calculations'].include?(opts[:'statement_code'])
    fail ArgumentError, 'invalid value for "statement_code", must be one of income_statement, balance_sheet_statement, cash_flow_statement, calculations'
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['QTR', 'YTD', 'FY', 'TTM'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of QTR, YTD, FY, TTM'
  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 CompanyApi.get_company_fundamentals, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/companies/{identifier}/fundamentals".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'filed_after'] = opts[:'filed_after'] if !opts[:'filed_after'].nil?
  query_params[:'filed_before'] = opts[:'filed_before'] if !opts[:'filed_before'].nil?
  query_params[:'reported_only'] = opts[:'reported_only'] if !opts[:'reported_only'].nil?
  query_params[:'fiscal_year'] = opts[:'fiscal_year'] if !opts[:'fiscal_year'].nil?
  query_params[:'statement_code'] = opts[:'statement_code'] if !opts[:'statement_code'].nil?
  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[:'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 => 'ApiResponseCompanyFundamentals')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanyApi#get_company_fundamentals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_company_historical_data(identifier, tag, opts = {}) ⇒ ApiResponseCompanyHistoricalData

Historical Data for Company Returns historical values for the given ‘tag` and the Company with the given `identifier`

Parameters:

Options Hash (opts):

  • :frequency (String) —

    Return historical data in the given frequency (default to daily)

  • :type (String) —

    Return historical data for given fiscal period type

  • :start_date (Date) —

    Return historical data on or after this date

  • :end_date (Date) —

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



513
514
515
516
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 513

def get_company_historical_data(identifier, tag, opts = {})
  data, _status_code, _headers = get_company_historical_data_with_http_info(identifier, tag, opts)
  return data
end

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

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

Parameters:

Options Hash (opts):

  • :frequency (String) —

    Return historical data in the given frequency

  • :type (String) —

    Return historical data for given fiscal period type

  • :start_date (Date) —

    Return historical data on or after this date

  • :end_date (Date) —

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



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 531

def get_company_historical_data_with_http_info(identifier, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyApi.get_company_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 CompanyApi.get_company_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 CompanyApi.get_company_historical_data"
  end
  if @api_client.config.client_side_validation && opts[:'frequency'] && !['daily', 'weekly', 'monthly', 'quarterly', 'yearly'].include?(opts[:'frequency'])
    fail ArgumentError, 'invalid value for "frequency", must be one of daily, weekly, monthly, quarterly, yearly'
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['FY', 'QTR', 'TTM'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of FY, QTR, TTM'
  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 CompanyApi.get_company_historical_data, must be smaller than or equal to 10000.'
  end

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

  # query parameters
  query_params = {}
  query_params[:'frequency'] = opts[:'frequency'] if !opts[:'frequency'].nil?
  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 => 'ApiResponseCompanyHistoricalData')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanyApi#get_company_historical_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_company_ipos(opts = {}) ⇒ ApiResponseInitialPublicOfferings

IPOs Returns initial public offerings (IPOs). An IPO is a public offering of private company stock. The act of "going public" is initiated by an IPO, at which point the company’s stock trades on a major stock exchange (such as NYSE or NASDAQ). Intrinio covers all upcoming and recent IPOs for US exchanges.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ticker (String) —

    Return IPOs with the given ticker (typically the IPO for the company)

  • :status (String) —

    Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occured and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand

  • :start_date (Date) —

    Return IPOs on or after the given date

  • :end_date (Date) —

    Return IPOs on or before the given date

  • :offer_amount_greater_than (Integer) —

    Return IPOs with an offer dollar amount greater than the given amount

  • :offer_amount_less_than (Integer) —

    Return IPOs with an offer dollar amount less than the given amount

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



605
606
607
608
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 605

def get_company_ipos(opts = {})
  data, _status_code, _headers = get_company_ipos_with_http_info(opts)
  return data
end

#get_company_ipos_with_http_info(opts = {}) ⇒ Array<(ApiResponseInitialPublicOfferings, Fixnum, Hash)>

IPOs Returns initial public offerings (IPOs). An IPO is a public offering of private company stock. The act of &quot;going public&quot; is initiated by an IPO, at which point the company&#39;s stock trades on a major stock exchange (such as NYSE or NASDAQ). Intrinio covers all upcoming and recent IPOs for US exchanges.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ticker (String) —

    Return IPOs with the given ticker (typically the IPO for the company)

  • :status (String) —

    Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occured and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand

  • :start_date (Date) —

    Return IPOs on or after the given date

  • :end_date (Date) —

    Return IPOs on or before the given date

  • :offer_amount_greater_than (Integer) —

    Return IPOs with an offer dollar amount greater than the given amount

  • :offer_amount_less_than (Integer) —

    Return IPOs with an offer dollar amount less than the given amount

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



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
668
669
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 622

def get_company_ipos_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyApi.get_company_ipos ..."
  end
  if @api_client.config.client_side_validation && opts[:'status'] && !['upcoming', 'priced', 'withdrawn'].include?(opts[:'status'])
    fail ArgumentError, 'invalid value for "status", must be one of upcoming, priced, withdrawn'
  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 CompanyApi.get_company_ipos, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/companies/ipos"

  # query parameters
  query_params = {}
  query_params[:'ticker'] = opts[:'ticker'] if !opts[:'ticker'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].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[:'offer_amount_greater_than'] = opts[:'offer_amount_greater_than'] if !opts[:'offer_amount_greater_than'].nil?
  query_params[:'offer_amount_less_than'] = opts[:'offer_amount_less_than'] if !opts[:'offer_amount_less_than'].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 => 'ApiResponseInitialPublicOfferings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanyApi#get_company_ipos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_company_news(identifier, opts = {}) ⇒ ApiResponseCompanyNews

All News by Company Returns news for the Company with the given ‘identifier`

Parameters:

  • identifier —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

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



678
679
680
681
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 678

def get_company_news(identifier, opts = {})
  data, _status_code, _headers = get_company_news_with_http_info(identifier, opts)
  return data
end

#get_company_news_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseCompanyNews, Fixnum, Hash)>

All News by Company Returns news for the Company with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

  • 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<(ApiResponseCompanyNews, Fixnum, Hash)>) —

    ApiResponseCompanyNews data, response status code and response headers



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
721
722
723
724
725
726
727
728
729
730
731
732
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 690

def get_company_news_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyApi.get_company_news ..."
  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 CompanyApi.get_company_news"
  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 CompanyApi.get_company_news, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/companies/{identifier}/news".sub('{' + 'identifier' + '}', identifier.to_s)

  # 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 => 'ApiResponseCompanyNews')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanyApi#get_company_news\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_company_securities(identifier, opts = {}) ⇒ ApiResponseCompanySecurities

All Securities by Company Returns Securities for the Company with the given ‘identifier`

Parameters:

  • identifier —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

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



740
741
742
743
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 740

def get_company_securities(identifier, opts = {})
  data, _status_code, _headers = get_company_securities_with_http_info(identifier, opts)
  return data
end

#get_company_securities_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseCompanySecurities, Fixnum, Hash)>

All Securities by Company Returns Securities for the Company with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

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



751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 751

def get_company_securities_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyApi.get_company_securities ..."
  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 CompanyApi.get_company_securities"
  end
  # resource path
  local_var_path = "/companies/{identifier}/securities".sub('{' + 'identifier' + '}', identifier.to_s)

  # 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 => 'ApiResponseCompanySecurities')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanyApi#get_company_securities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_company_with_http_info(identifier, opts = {}) ⇒ Array<(Company, Fixnum, Hash)>

Lookup Company Returns the Company with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

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

    the optional parameters

Returns:

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

    Company data, response status code and response headers



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 179

def get_company_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyApi.get_company ..."
  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 CompanyApi.get_company"
  end
  # resource path
  local_var_path = "/companies/{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 => 'Company')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanyApi#get_company\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year, opts = {}) ⇒ Fundamental

Lookup Fundamental by Company Returns the Fundamental for the Company with the given ‘identifier` and with the given parameters

Parameters:

  • identifier —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

  • statement_code —

    The statement code

  • fiscal_period —

    The fiscal period

  • fiscal_year —

    The fiscal year

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

    the optional parameters

Returns:



798
799
800
801
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 798

def lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year, opts = {})
  data, _status_code, _headers = lookup_company_fundamental_with_http_info(identifier, statement_code, fiscal_period, fiscal_year, opts)
  return data
end

#lookup_company_fundamental_with_http_info(identifier, statement_code, fiscal_period, fiscal_year, opts = {}) ⇒ Array<(Fundamental, Fixnum, Hash)>

Lookup Fundamental by Company Returns the Fundamental for the Company with the given &#x60;identifier&#x60; and with the given parameters

Parameters:

  • identifier —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

  • statement_code —

    The statement code

  • fiscal_period —

    The fiscal period

  • fiscal_year —

    The fiscal year

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

    the optional parameters

Returns:

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

    Fundamental data, response status code and response headers



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

def lookup_company_fundamental_with_http_info(identifier, statement_code, fiscal_period, fiscal_year, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyApi.lookup_company_fundamental ..."
  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 CompanyApi.lookup_company_fundamental"
  end
  # verify the required parameter 'statement_code' is set
  if @api_client.config.client_side_validation && statement_code.nil?
    fail ArgumentError, "Missing the required parameter 'statement_code' when calling CompanyApi.lookup_company_fundamental"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['income_statement', 'balance_sheet_statement', 'cash_flow_statement', 'calculations'].include?(statement_code)
    fail ArgumentError, "invalid value for 'statement_code', must be one of income_statement, balance_sheet_statement, cash_flow_statement, calculations"
  end
  # verify the required parameter 'fiscal_period' is set
  if @api_client.config.client_side_validation && fiscal_period.nil?
    fail ArgumentError, "Missing the required parameter 'fiscal_period' when calling CompanyApi.lookup_company_fundamental"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Q1TTM', 'Q2TTM', 'Q3TTM', 'FY', 'Q1', 'Q2', 'Q3', 'Q4', 'Q2YTD', 'Q3YTD'].include?(fiscal_period)
    fail ArgumentError, "invalid value for 'fiscal_period', must be one of Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD"
  end
  # verify the required parameter 'fiscal_year' is set
  if @api_client.config.client_side_validation && fiscal_year.nil?
    fail ArgumentError, "Missing the required parameter 'fiscal_year' when calling CompanyApi.lookup_company_fundamental"
  end
  # resource path
  local_var_path = "/companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period}".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'statement_code' + '}', statement_code.to_s).sub('{' + 'fiscal_period' + '}', fiscal_period.to_s).sub('{' + 'fiscal_year' + '}', fiscal_year.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 => 'Fundamental')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanyApi#lookup_company_fundamental\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_companies(query, opts = {}) ⇒ ApiResponseCompaniesSearch

Search Companies Searches for Companies matching the text ‘query`

Parameters:

  • query —

    Search parameters

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return (default to 100)

Returns:



875
876
877
878
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 875

def search_companies(query, opts = {})
  data, _status_code, _headers = search_companies_with_http_info(query, opts)
  return data
end

#search_companies_with_http_info(query, opts = {}) ⇒ Array<(ApiResponseCompaniesSearch, Fixnum, Hash)>

Search Companies Searches for Companies matching the text &#x60;query&#x60;

Parameters:

  • query —

    Search parameters

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return

Returns:

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

    ApiResponseCompaniesSearch data, response status code and response headers



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
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'lib/intrinio-sdk/api/company_api.rb', line 886

def search_companies_with_http_info(query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyApi.search_companies ..."
  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 CompanyApi.search_companies"
  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 CompanyApi.search_companies, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/companies/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 => 'ApiResponseCompaniesSearch')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanyApi#search_companies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end