docs/FundamentalsApi.md in intrinio-sdk-3.0.0 vs docs/FundamentalsApi.md in intrinio-sdk-3.1.0

- old
+ new

@@ -8,25 +8,55 @@ [**get_fundamental_reported_financials**](FundamentalsApi.md#get_fundamental_reported_financials) | **GET** /fundamentals/{id}/reported_financials | Reported Financials [**get_fundamental_standardized_financials**](FundamentalsApi.md#get_fundamental_standardized_financials) | **GET** /fundamentals/{id}/standardized_financials | Standardized Financials [**lookup_fundamental**](FundamentalsApi.md#lookup_fundamental) | **GET** /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental -# **get_fundamental_by_id** + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::FundamentalsApi) + +[//]: # (METHOD:get_fundamental_by_id) + +[//]: # (RETURN_TYPE:Intrinio::Fundamental) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:Fundamental.md) + +[//]: # (OPERATION:get_fundamental_by_id_v2) + +[//]: # (ENDPOINT:/fundamentals/{id}) + +[//]: # (DOCUMENT_LINK:FundamentalsApi.md#get_fundamental_by_id) + +## **get_fundamental_by_id** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_fundamental_by_id_v2) + +[//]: # (START_OVERVIEW) + > Fundamental get_fundamental_by_id(id) -Fundamental by ID +#### Fundamental by ID + Returns detailed fundamental data for the given `id`. +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end fundamentals_api = Intrinio::FundamentalsApi.new id = "fun_ge9LlE" # String | The Intrinio ID for the Fundamental @@ -38,35 +68,77 @@ rescue Intrinio::ApiError => e puts "Exception when calling FundamentalsApi->get_fundamental_by_id: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **String**| The Intrinio ID for the Fundamental | + **id** | String| The Intrinio ID for the Fundamental | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**Fundamental**](Fundamental.md) -# **get_fundamental_reported_financials** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::FundamentalsApi) + +[//]: # (METHOD:get_fundamental_reported_financials) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseReportedFinancials) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseReportedFinancials.md) + +[//]: # (OPERATION:get_fundamental_reported_financials_v2) + +[//]: # (ENDPOINT:/fundamentals/{id}/reported_financials) + +[//]: # (DOCUMENT_LINK:FundamentalsApi.md#get_fundamental_reported_financials) + +## **get_fundamental_reported_financials** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_fundamental_reported_financials_v2) + +[//]: # (START_OVERVIEW) + > ApiResponseReportedFinancials get_fundamental_reported_financials(id) -Reported Financials +#### Reported Financials + Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end fundamentals_api = Intrinio::FundamentalsApi.new id = "AAPL-income_statement-2018-Q1" # String | The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental @@ -78,35 +150,77 @@ rescue Intrinio::ApiError => e puts "Exception when calling FundamentalsApi->get_fundamental_reported_financials: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **String**| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental | + **id** | String| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseReportedFinancials**](ApiResponseReportedFinancials.md) -# **get_fundamental_standardized_financials** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::FundamentalsApi) + +[//]: # (METHOD:get_fundamental_standardized_financials) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseStandardizedFinancials) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseStandardizedFinancials.md) + +[//]: # (OPERATION:get_fundamental_standardized_financials_v2) + +[//]: # (ENDPOINT:/fundamentals/{id}/standardized_financials) + +[//]: # (DOCUMENT_LINK:FundamentalsApi.md#get_fundamental_standardized_financials) + +## **get_fundamental_standardized_financials** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_fundamental_standardized_financials_v2) + +[//]: # (START_OVERVIEW) + > ApiResponseStandardizedFinancials get_fundamental_standardized_financials(id) -Standardized Financials +#### 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. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as reported financial statements because of the inherent complexity of reporting standards. +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end fundamentals_api = Intrinio::FundamentalsApi.new id = "AAPL-income_statement-2018-Q1" # String | The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental @@ -118,35 +232,77 @@ rescue Intrinio::ApiError => e puts "Exception when calling FundamentalsApi->get_fundamental_standardized_financials: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **String**| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental | + **id** | String| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseStandardizedFinancials**](ApiResponseStandardizedFinancials.md) -# **lookup_fundamental** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::FundamentalsApi) + +[//]: # (METHOD:lookup_fundamental) + +[//]: # (RETURN_TYPE:Intrinio::Fundamental) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:Fundamental.md) + +[//]: # (OPERATION:lookup_fundamental_v2) + +[//]: # (ENDPOINT:/fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period}) + +[//]: # (DOCUMENT_LINK:FundamentalsApi.md#lookup_fundamental) + +## **lookup_fundamental** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/lookup_fundamental_v2) + +[//]: # (START_OVERVIEW) + > Fundamental lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period) -Lookup Fundamental +#### Lookup Fundamental + Returns the Fundamental for the Company with the given `identifier` and with the given parameters +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end fundamentals_api = Intrinio::FundamentalsApi.new identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID) @@ -164,18 +320,30 @@ rescue Intrinio::ApiError => e puts "Exception when calling FundamentalsApi->lookup_fundamental: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | - **statement_code** | **String**| The statement code | - **fiscal_year** | **Integer**| The fiscal year | - **fiscal_period** | **String**| The fiscal period | + **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | &nbsp; + **statement_code** | String| The statement code | &nbsp; + **fiscal_year** | Integer| The fiscal year | &nbsp; + **fiscal_period** | String| The fiscal period | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**Fundamental**](Fundamental.md) + +[//]: # (END_OPERATION)