Class: Intrinio::FundamentalsApi
- Inherits:
-
Object
- Object
- Intrinio::FundamentalsApi
- Defined in:
- lib/intrinio-sdk/api/fundamentals_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#filter_fundamental(opts = {}) ⇒ Fundamental
Filter Fundamental Returns fundamentals that meet the set of filters specified in parameters.
-
#filter_fundamental_with_http_info(opts = {}) ⇒ Array<(Fundamental, Fixnum, Hash)>
Filter Fundamental Returns fundamentals that meet the set of filters specified in parameters.
-
#get_fundamental_by_id(id, opts = {}) ⇒ Fundamental
Fundamental by ID Returns a specific fundamental associated with a particular unique fundamental ID.
-
#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.
-
#get_fundamental_reported_financials(id, opts = {}) ⇒ ApiResponseReportedFinancials
Reported Financials Returns as-reported financial statement data for income statement, balance sheet, and cash flow statement.
-
#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.
-
#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.
-
#get_fundamental_standardized_financials_dimensions(id, tag, opts = {}) ⇒ ApiResponseStandardizedFinancialsDimensions
Standardized Financials Dimensions Returns as reported dimensionality of a data tag.
-
#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.
-
#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.
-
#initialize(api_client = ApiClient.default) ⇒ FundamentalsApi
constructor
A new instance of FundamentalsApi.
-
#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.
-
#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.
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.
40 41 42 43 |
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 40 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.
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 108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 62 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 if @api_client.config.client_side_validation && opts[:'template'] && !['fin', 'indu'].include?(opts[:'template']) fail ArgumentError, 'invalid value for "template", must be one of fin, indu' 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[:'updated_after'] = opts[:'updated_after'] if !opts[:'updated_after'].nil? query_params[:'updated_before'] = opts[:'updated_before'] if !opts[:'updated_before'].nil? query_params[:'template'] = opts[:'template'] if !opts[:'template'].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.
126 127 128 129 |
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 126 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.
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 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 136 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.
179 180 181 182 |
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 179 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.
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 189 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.
232 233 234 235 |
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 232 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
286 287 288 289 |
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 286 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
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 334 335 336 337 |
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 297 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.
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 275 276 277 278 |
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 242 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.
347 348 349 350 |
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 347 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.
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 406 407 408 409 410 411 412 413 414 415 416 |
# File 'lib/intrinio-sdk/api/fundamentals_api.rb', line 360 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 |