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

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

Fundamental by ID Returns detailed fundamental data for the given ‘id`.

Parameters:

  • id —

    The Intrinio ID for the Fundamental

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

    the optional parameters

Returns:



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

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 detailed fundamental data for the given &#x60;id&#x60;.

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



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
72
73
74
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 38

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 the As-Reported Financials directly from the financial statements of the XBRL filings from the company

Parameters:

  • id —

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

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

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 81

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 the As-Reported Financials directly from the financial statements of the XBRL filings from the company

Parameters:

  • id —

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

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

    the optional parameters

Returns:



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
122
123
124
125
126
127
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 91

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 professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies’ fundamentals.

Parameters:

  • id —

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

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

    the optional parameters

Returns:



134
135
136
137
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 134

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:



188
189
190
191
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 188

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:



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 199

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 professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies&#39; fundamentals.

Parameters:

  • id —

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

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

    the optional parameters

Returns:



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
172
173
174
175
176
177
178
179
180
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 144

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 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_year —

    The fiscal year

  • fiscal_period —

    The fiscal period

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

    the optional parameters

Returns:



249
250
251
252
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 249

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 262

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