Class: Intrinio::FundamentalsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FundamentalsApi

Returns a new instance of FundamentalsApi.



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

def api_client
  @api_client
end

Instance Method Details

#filter_fundamental(opts = {}) ⇒ Fundamental

Filter Fundamental Returns fundamentals that meet the set of filters specified in parameters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filed_after (Date) —

    Only include fundamentals that were filed on or after this date.

  • :filed_before (Date) —

    Only include fundamentals that were 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

  • :fiscal_period (String) —

    The fiscal period

  • :start_date (Date) —

    Only include fundamentals where covered period is on or after this date.

  • :end_date (Date) —

    Only include fundamentals where covered period is on or before this date.

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



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

def filter_fundamental(opts = {})
  data, _status_code, _headers = filter_fundamental_with_http_info(opts)
  return data
end

#filter_fundamental_with_http_info(opts = {}) ⇒ Array<(Fundamental, Fixnum, Hash)>

Filter Fundamental Returns fundamentals that meet the set of filters specified in parameters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filed_after (Date) —

    Only include fundamentals that were filed on or after this date.

  • :filed_before (Date) —

    Only include fundamentals that were 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

  • :fiscal_period (String) —

    The fiscal period

  • :start_date (Date) —

    Only include fundamentals where covered period is on or after this date.

  • :end_date (Date) —

    Only include fundamentals where covered period is on or before this date.

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:

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

    Fundamental 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
106
107
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 56

def filter_fundamental_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FundamentalsApi.filter_fundamental ..."
  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[:'fiscal_period'] && !['Q1TTM', 'Q2TTM', 'Q3TTM', 'FY', 'Q1', 'Q2', 'Q3', 'Q4', 'Q2YTD', 'Q3YTD'].include?(opts[:'fiscal_period'])
    fail ArgumentError, 'invalid value for "fiscal_period", must be one of Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD'
  end
  # resource path
  local_var_path = "/fundamentals"

  # 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[:'fiscal_period'] = opts[:'fiscal_period'] if !opts[:'fiscal_period'].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[:'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 => 'Fundamental')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FundamentalsApi#filter_fundamental\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fundamental_by_id(id, opts = {}) ⇒ Fundamental

Fundamental by ID Returns a specific fundamental associated with a particular unique fundamental ID. Useful for pulling reference data for a specific fundamental.

Parameters:

  • id —

    The Intrinio ID for the Fundamental

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

    the optional parameters

Returns:



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

def get_fundamental_by_id(id, opts = {})
  data, _status_code, _headers = get_fundamental_by_id_with_http_info(id, opts)
  return data
end

#get_fundamental_by_id_with_http_info(id, opts = {}) ⇒ Array<(Fundamental, Fixnum, Hash)>

Fundamental by ID Returns a specific fundamental associated with a particular unique fundamental ID. Useful for pulling reference data for a specific fundamental.

Parameters:

  • id —

    The Intrinio ID for the Fundamental

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

    the optional parameters

Returns:

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

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

def get_fundamental_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FundamentalsApi.get_fundamental_by_id ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FundamentalsApi.get_fundamental_by_id"
  end
  # resource path
  local_var_path = "/fundamentals/{id}".sub('{' + 'id' + '}', id.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: FundamentalsApi#get_fundamental_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fundamental_reported_financials(id, opts = {}) ⇒ ApiResponseReportedFinancials

Reported Financials Returns as-reported financial statement data for income statement, balance sheet, and cash flow statement. Data for income statement and cash flow statement is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.

Parameters:

  • id —

    The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental

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

    the optional parameters

Returns:



167
168
169
170
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 167

def get_fundamental_reported_financials(id, opts = {})
  data, _status_code, _headers = get_fundamental_reported_financials_with_http_info(id, opts)
  return data
end

#get_fundamental_reported_financials_with_http_info(id, opts = {}) ⇒ Array<(ApiResponseReportedFinancials, Fixnum, Hash)>

Reported Financials Returns as-reported financial statement data for income statement, balance sheet, and cash flow statement. Data for income statement and cash flow statement is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.

Parameters:

  • id —

    The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental

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

    the optional parameters

Returns:



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

def get_fundamental_reported_financials_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FundamentalsApi.get_fundamental_reported_financials ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FundamentalsApi.get_fundamental_reported_financials"
  end
  # resource path
  local_var_path = "/fundamentals/{id}/reported_financials".sub('{' + 'id' + '}', id.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 => 'ApiResponseReportedFinancials')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FundamentalsApi#get_fundamental_reported_financials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fundamental_standardized_financials(id, opts = {}) ⇒ ApiResponseStandardizedFinancials

Standardized Financials Returns standardized financial statement data for income statement, balance sheet, cash flow statement and over 100 associated calculations for a given company. Data for income statement, cash flow statement, and calculations is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.

Parameters:

  • id —

    The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental

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

    the optional parameters

Returns:



220
221
222
223
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 220

def get_fundamental_standardized_financials(id, opts = {})
  data, _status_code, _headers = get_fundamental_standardized_financials_with_http_info(id, opts)
  return data
end

#get_fundamental_standardized_financials_dimensions(id, tag, opts = {}) ⇒ ApiResponseStandardizedFinancialsDimensions

Standardized Financials Dimensions Returns as reported dimensionality of a data tag

Parameters:

Returns:



274
275
276
277
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 274

def get_fundamental_standardized_financials_dimensions(id, tag, opts = {})
  data, _status_code, _headers = get_fundamental_standardized_financials_dimensions_with_http_info(id, tag, opts)
  return data
end

#get_fundamental_standardized_financials_dimensions_with_http_info(id, tag, opts = {}) ⇒ Array<(ApiResponseStandardizedFinancialsDimensions, Fixnum, Hash)>

Standardized Financials Dimensions Returns as reported dimensionality of a data tag

Parameters:

Returns:



285
286
287
288
289
290
291
292
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
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 285

def get_fundamental_standardized_financials_dimensions_with_http_info(id, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FundamentalsApi.get_fundamental_standardized_financials_dimensions ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FundamentalsApi.get_fundamental_standardized_financials_dimensions"
  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 FundamentalsApi.get_fundamental_standardized_financials_dimensions"
  end
  # resource path
  local_var_path = "/fundamentals/{id}/standardized_financials/dimensions/{tag}".sub('{' + 'id' + '}', id.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(['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 => 'ApiResponseStandardizedFinancialsDimensions')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FundamentalsApi#get_fundamental_standardized_financials_dimensions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fundamental_standardized_financials_with_http_info(id, opts = {}) ⇒ Array<(ApiResponseStandardizedFinancials, Fixnum, Hash)>

Standardized Financials Returns standardized financial statement data for income statement, balance sheet, cash flow statement and over 100 associated calculations for a given company. Data for income statement, cash flow statement, and calculations is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.

Parameters:

  • id —

    The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental

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

    the optional parameters

Returns:



230
231
232
233
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
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 230

def get_fundamental_standardized_financials_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FundamentalsApi.get_fundamental_standardized_financials ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FundamentalsApi.get_fundamental_standardized_financials"
  end
  # resource path
  local_var_path = "/fundamentals/{id}/standardized_financials".sub('{' + 'id' + '}', id.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 => 'ApiResponseStandardizedFinancials')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FundamentalsApi#get_fundamental_standardized_financials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Lookup Fundamental Returns a specific fundamental with unique fundamental ID associated with a particular company, year, period and statement. Useful for pulling the unique fundamental ID and reference data for a specific fundamental.

Parameters:

  • identifier —

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

  • statement_code —

    The statement code

  • fiscal_year —

    The fiscal year

  • fiscal_period —

    The fiscal period

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

    the optional parameters

Returns:



335
336
337
338
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 335

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

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

Lookup Fundamental Returns a specific fundamental with unique fundamental ID associated with a particular company, year, period and statement. Useful for pulling the unique fundamental ID and reference data for a specific fundamental.

Parameters:

  • identifier —

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

  • statement_code —

    The statement code

  • fiscal_year —

    The fiscal year

  • fiscal_period —

    The fiscal period

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

    the optional parameters

Returns:

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

    Fundamental data, response status code and response headers



348
349
350
351
352
353
354
355
356
357
358
359
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
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 348

def lookup_fundamental_with_http_info(identifier, statement_code, fiscal_year, fiscal_period, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FundamentalsApi.lookup_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 FundamentalsApi.lookup_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 FundamentalsApi.lookup_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_year' is set
  if @api_client.config.client_side_validation && fiscal_year.nil?
    fail ArgumentError, "Missing the required parameter 'fiscal_year' when calling FundamentalsApi.lookup_fundamental"
  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 FundamentalsApi.lookup_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
  # resource path
  local_var_path = "/fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period}".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'statement_code' + '}', statement_code.to_s).sub('{' + 'fiscal_year' + '}', fiscal_year.to_s).sub('{' + 'fiscal_period' + '}', fiscal_period.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: FundamentalsApi#lookup_fundamental\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end