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

- old
+ new

@@ -22,23 +22,54 @@ [**search_economic_indices**](IndexApi.md#search_economic_indices) | **GET** /indices/economic/search | Search Economic Indices [**search_sic_indices**](IndexApi.md#search_sic_indices) | **GET** /indices/sic/search | Search SIC Indices [**search_stock_markets_indices**](IndexApi.md#search_stock_markets_indices) | **GET** /indices/stock_market/search | Search Stock Market Indices -# **get_all_economic_indices** + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:get_all_economic_indices) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseEconomicIndices) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseEconomicIndices.md) + +[//]: # (OPERATION:get_all_economic_indices_v2) + +[//]: # (ENDPOINT:/indices/economic) + +[//]: # (DOCUMENT_LINK:IndexApi.md#get_all_economic_indices) + +## **get_all_economic_indices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_economic_indices_v2) + +[//]: # (START_OVERVIEW) + > ApiResponseEconomicIndices get_all_economic_indices(opts) -All Economic Indices +#### All Economic Indices + + +[//]: # (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 index_api = Intrinio::IndexApi.new opts = { @@ -52,34 +83,77 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_all_economic_indices: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseEconomicIndices**](ApiResponseEconomicIndices.md) -# **get_all_sic_indices** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:get_all_sic_indices) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSICIndices) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSICIndices.md) + +[//]: # (OPERATION:get_all_sic_indices_v2) + +[//]: # (ENDPOINT:/indices/sic) + +[//]: # (DOCUMENT_LINK:IndexApi.md#get_all_sic_indices) + +## **get_all_sic_indices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_sic_indices_v2) + +[//]: # (START_OVERVIEW) + > ApiResponseSICIndices get_all_sic_indices(opts) -All SIC Indices +#### All SIC Indices + + +[//]: # (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 index_api = Intrinio::IndexApi.new opts = { @@ -93,34 +167,77 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_all_sic_indices: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSICIndices**](ApiResponseSICIndices.md) -# **get_all_stock_market_indices** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:get_all_stock_market_indices) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseStockMarketIndices) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseStockMarketIndices.md) + +[//]: # (OPERATION:get_all_stock_market_indices_v2) + +[//]: # (ENDPOINT:/indices/stock_market) + +[//]: # (DOCUMENT_LINK:IndexApi.md#get_all_stock_market_indices) + +## **get_all_stock_market_indices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_stock_market_indices_v2) + +[//]: # (START_OVERVIEW) + > ApiResponseStockMarketIndices get_all_stock_market_indices(opts) -All Stock Market Indices +#### All Stock Market Indices + + +[//]: # (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 index_api = Intrinio::IndexApi.new opts = { @@ -134,34 +251,77 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_all_stock_market_indices: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseStockMarketIndices**](ApiResponseStockMarketIndices.md) -# **get_economic_index_by_id** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:get_economic_index_by_id) + +[//]: # (RETURN_TYPE:Intrinio::EconomicIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:EconomicIndex.md) + +[//]: # (OPERATION:get_economic_index_by_id_v2) + +[//]: # (ENDPOINT:/indices/economic/{identifier}) + +[//]: # (DOCUMENT_LINK:IndexApi.md#get_economic_index_by_id) + +## **get_economic_index_by_id** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_economic_index_by_id_v2) + +[//]: # (START_OVERVIEW) + > EconomicIndex get_economic_index_by_id(identifier) -Lookup Economic Index +#### Lookup Economic Index + + +[//]: # (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 index_api = Intrinio::IndexApi.new identifier = "$GDP" # String | An Index Identifier (symbol, Intrinio ID) @@ -173,35 +333,77 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_economic_index_by_id: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | + **identifier** | String| An Index Identifier (symbol, Intrinio ID) | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**EconomicIndex**](EconomicIndex.md) -# **get_economic_index_data_point_number** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:get_economic_index_data_point_number) + +[//]: # (RETURN_TYPE:Float) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:get_economic_index_data_point_number_v2) + +[//]: # (ENDPOINT:/indices/economic/{identifier}/data_point/{tag}/number) + +[//]: # (DOCUMENT_LINK:IndexApi.md#get_economic_index_data_point_number) + +## **get_economic_index_data_point_number** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_economic_index_data_point_number_v2) + +[//]: # (START_OVERVIEW) + > Float get_economic_index_data_point_number(identifier, tag) -Data Point (Number) for an Economic Index +#### Data Point (Number) for an Economic Index + Returns a numeric value for the given `tag` for the Economic Index with the given `identifier` +[//]: # (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 index_api = Intrinio::IndexApi.new identifier = "$GDP" # String | An Index Identifier (symbol, Intrinio ID) @@ -215,36 +417,78 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_economic_index_data_point_number: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | - **tag** | **String**| An Intrinio data tag &lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a&gt; | + **identifier** | String| An Index Identifier (symbol, Intrinio ID) | &nbsp; + **tag** | String| An Intrinio data tag &lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a&gt; | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type **Float** -# **get_economic_index_data_point_text** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:get_economic_index_data_point_text) + +[//]: # (RETURN_TYPE:String) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:get_economic_index_data_point_text_v2) + +[//]: # (ENDPOINT:/indices/economic/{identifier}/data_point/{tag}/text) + +[//]: # (DOCUMENT_LINK:IndexApi.md#get_economic_index_data_point_text) + +## **get_economic_index_data_point_text** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_economic_index_data_point_text_v2) + +[//]: # (START_OVERVIEW) + > String get_economic_index_data_point_text(identifier, tag) -Data Point (Text) for an Economic Index +#### Data Point (Text) for an Economic Index + Returns a text value for the given `tag` for the Economic Index with the given `identifier` +[//]: # (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 index_api = Intrinio::IndexApi.new identifier = "$GDP" # String | An Index Identifier (symbol, Intrinio ID) @@ -258,36 +502,78 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_economic_index_data_point_text: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | - **tag** | **String**| An Intrinio data tag ID or code-name | + **identifier** | String| An Index Identifier (symbol, Intrinio ID) | &nbsp; + **tag** | String| An Intrinio data tag ID or code-name | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type **String** -# **get_economic_index_historical_data** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:get_economic_index_historical_data) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseEconomicIndexHistoricalData) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseEconomicIndexHistoricalData.md) + +[//]: # (OPERATION:get_economic_index_historical_data_v2) + +[//]: # (ENDPOINT:/indices/economic/{identifier}/historical_data/{tag}) + +[//]: # (DOCUMENT_LINK:IndexApi.md#get_economic_index_historical_data) + +## **get_economic_index_historical_data** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_economic_index_historical_data_v2) + +[//]: # (START_OVERVIEW) + > ApiResponseEconomicIndexHistoricalData get_economic_index_historical_data(identifier, tag, opts) -Historical Data for an Economic Index +#### Historical Data for an Economic Index + Returns historical values for the given `tag` and the Economic Index with the given `identifier` +[//]: # (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 index_api = Intrinio::IndexApi.new identifier = "$GDP" # String | An Index Identifier (symbol, Intrinio ID) @@ -309,40 +595,83 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_economic_index_historical_data: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | - **tag** | **String**| An Intrinio data tag &lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a&gt; | - **type** | **String**| Filter by type, when applicable | [optional] - **start_date** | **Date**| Get historical data on or after this date | [optional] - **end_date** | **Date**| Get historical data on or before this date | [optional] - **sort_order** | **String**| Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; | [optional] [default to desc] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| An Index Identifier (symbol, Intrinio ID) | &nbsp; + **tag** | String| An Intrinio data tag &lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a&gt; | &nbsp; + **type** | String| Filter by type, when applicable | [optional] &nbsp; + **start_date** | Date| Get historical data on or after this date | [optional] &nbsp; + **end_date** | Date| Get historical data on or before this date | [optional] &nbsp; + **sort_order** | String| Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; | [optional] [default to desc] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseEconomicIndexHistoricalData**](ApiResponseEconomicIndexHistoricalData.md) -# **get_sic_index_by_id** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:get_sic_index_by_id) + +[//]: # (RETURN_TYPE:Intrinio::SICIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:SICIndex.md) + +[//]: # (OPERATION:get_sic_index_by_id_v2) + +[//]: # (ENDPOINT:/indices/sic/{identifier}) + +[//]: # (DOCUMENT_LINK:IndexApi.md#get_sic_index_by_id) + +## **get_sic_index_by_id** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_sic_index_by_id_v2) + +[//]: # (START_OVERVIEW) + > SICIndex get_sic_index_by_id(identifier) -Lookup SIC Index +#### Lookup SIC Index + + +[//]: # (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 index_api = Intrinio::IndexApi.new identifier = "$SIC.1" # String | An Index Identifier (symbol, Intrinio ID) @@ -354,35 +683,77 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_sic_index_by_id: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | + **identifier** | String| An Index Identifier (symbol, Intrinio ID) | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**SICIndex**](SICIndex.md) -# **get_sic_index_data_point_number** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:get_sic_index_data_point_number) + +[//]: # (RETURN_TYPE:Float) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:get_sic_index_data_point_number_v2) + +[//]: # (ENDPOINT:/indices/sic/{identifier}/data_point/{tag}/number) + +[//]: # (DOCUMENT_LINK:IndexApi.md#get_sic_index_data_point_number) + +## **get_sic_index_data_point_number** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_sic_index_data_point_number_v2) + +[//]: # (START_OVERVIEW) + > Float get_sic_index_data_point_number(identifier, tag) -Data Point (Number) for an SIC Index +#### Data Point (Number) for an SIC Index + Returns a numeric value for the given `tag` for the SIC Index with the given `identifier` +[//]: # (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 index_api = Intrinio::IndexApi.new identifier = "$SIC.1" # String | An Index Identifier (symbol, Intrinio ID) @@ -396,36 +767,78 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_sic_index_data_point_number: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | - **tag** | **String**| An Intrinio data tag ID or code-name | + **identifier** | String| An Index Identifier (symbol, Intrinio ID) | &nbsp; + **tag** | String| An Intrinio data tag ID or code-name | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type **Float** -# **get_sic_index_data_point_text** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:get_sic_index_data_point_text) + +[//]: # (RETURN_TYPE:String) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:get_sic_index_data_point_text_v2) + +[//]: # (ENDPOINT:/indices/sic/{identifier}/data_point/{tag}/text) + +[//]: # (DOCUMENT_LINK:IndexApi.md#get_sic_index_data_point_text) + +## **get_sic_index_data_point_text** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_sic_index_data_point_text_v2) + +[//]: # (START_OVERVIEW) + > String get_sic_index_data_point_text(identifier, tag) -Data Point (Text) for an SIC Index +#### Data Point (Text) for an SIC Index + Returns a text value for the given `tag` for the SIC Index with the given `identifier` +[//]: # (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 index_api = Intrinio::IndexApi.new identifier = "$SIC.1" # String | An Index Identifier (symbol, Intrinio ID) @@ -439,36 +852,78 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_sic_index_data_point_text: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | - **tag** | **String**| An Intrinio data tag ID or code-name | + **identifier** | String| An Index Identifier (symbol, Intrinio ID) | &nbsp; + **tag** | String| An Intrinio data tag ID or code-name | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type **String** -# **get_sic_index_historical_data** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:get_sic_index_historical_data) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSICIndexHistoricalData) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSICIndexHistoricalData.md) + +[//]: # (OPERATION:get_sic_index_historical_data_v2) + +[//]: # (ENDPOINT:/indices/sic/{identifier}/historical_data/{tag}) + +[//]: # (DOCUMENT_LINK:IndexApi.md#get_sic_index_historical_data) + +## **get_sic_index_historical_data** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_sic_index_historical_data_v2) + +[//]: # (START_OVERVIEW) + > ApiResponseSICIndexHistoricalData get_sic_index_historical_data(identifier, tag, opts) -Historical Data for an SIC Index +#### Historical Data for an SIC Index + Returns historical values for the given `tag` and the SIC Index with the given `identifier` +[//]: # (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 index_api = Intrinio::IndexApi.new identifier = "$SIC.1" # String | An Index Identifier (symbol, Intrinio ID) @@ -490,40 +945,83 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_sic_index_historical_data: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | - **tag** | **String**| An Intrinio data tag ID or code-name | - **type** | **String**| Filter by type, when applicable | [optional] - **start_date** | **Date**| Get historical data on or after this date | [optional] - **end_date** | **Date**| Get historical data on or before this date | [optional] - **sort_order** | **String**| Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; | [optional] [default to desc] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| An Index Identifier (symbol, Intrinio ID) | &nbsp; + **tag** | String| An Intrinio data tag ID or code-name | &nbsp; + **type** | String| Filter by type, when applicable | [optional] &nbsp; + **start_date** | Date| Get historical data on or after this date | [optional] &nbsp; + **end_date** | Date| Get historical data on or before this date | [optional] &nbsp; + **sort_order** | String| Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; | [optional] [default to desc] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSICIndexHistoricalData**](ApiResponseSICIndexHistoricalData.md) -# **get_stock_market_index_by_id** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:get_stock_market_index_by_id) + +[//]: # (RETURN_TYPE:Intrinio::StockMarketIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:StockMarketIndex.md) + +[//]: # (OPERATION:get_stock_market_index_by_id_v2) + +[//]: # (ENDPOINT:/indices/stock_market/{identifier}) + +[//]: # (DOCUMENT_LINK:IndexApi.md#get_stock_market_index_by_id) + +## **get_stock_market_index_by_id** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_stock_market_index_by_id_v2) + +[//]: # (START_OVERVIEW) + > StockMarketIndex get_stock_market_index_by_id(identifier) -Lookup Stock Market Index +#### Lookup Stock Market Index + + +[//]: # (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 index_api = Intrinio::IndexApi.new identifier = "$DJI" # String | An Index Identifier (symbol, Intrinio ID) @@ -535,35 +1033,77 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_stock_market_index_by_id: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | + **identifier** | String| An Index Identifier (symbol, Intrinio ID) | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**StockMarketIndex**](StockMarketIndex.md) -# **get_stock_market_index_data_point_number** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:get_stock_market_index_data_point_number) + +[//]: # (RETURN_TYPE:Float) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:get_stock_market_index_data_point_number_v2) + +[//]: # (ENDPOINT:/indices/stock_market/{identifier}/data_point/{tag}/number) + +[//]: # (DOCUMENT_LINK:IndexApi.md#get_stock_market_index_data_point_number) + +## **get_stock_market_index_data_point_number** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_stock_market_index_data_point_number_v2) + +[//]: # (START_OVERVIEW) + > Float get_stock_market_index_data_point_number(identifier, tag) -Data Point (Number) for Stock Market Index +#### Data Point (Number) for Stock Market Index + Returns a numeric value for the given `tag` for the Stock Market Index with the given `identifier` +[//]: # (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 index_api = Intrinio::IndexApi.new identifier = "$DJI" # String | An Index Identifier (symbol, Intrinio ID) @@ -577,36 +1117,78 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_stock_market_index_data_point_number: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | - **tag** | **String**| An Intrinio data tag ID or code-name | + **identifier** | String| An Index Identifier (symbol, Intrinio ID) | &nbsp; + **tag** | String| An Intrinio data tag ID or code-name | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type **Float** -# **get_stock_market_index_data_point_text** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:get_stock_market_index_data_point_text) + +[//]: # (RETURN_TYPE:String) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:get_stock_market_index_data_point_text_v2) + +[//]: # (ENDPOINT:/indices/stock_market/{identifier}/data_point/{tag}/text) + +[//]: # (DOCUMENT_LINK:IndexApi.md#get_stock_market_index_data_point_text) + +## **get_stock_market_index_data_point_text** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_stock_market_index_data_point_text_v2) + +[//]: # (START_OVERVIEW) + > String get_stock_market_index_data_point_text(identifier, tag) -Data Point (Text) for Stock Market Index +#### Data Point (Text) for Stock Market Index + Returns a text value for the given `tag` for the Stock Market Index with the given `identifier` +[//]: # (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 index_api = Intrinio::IndexApi.new identifier = "$DJI" # String | An Index Identifier (symbol, Intrinio ID) @@ -620,36 +1202,78 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_stock_market_index_data_point_text: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | - **tag** | **String**| An Intrinio data tag ID or code-name | + **identifier** | String| An Index Identifier (symbol, Intrinio ID) | &nbsp; + **tag** | String| An Intrinio data tag ID or code-name | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type **String** -# **get_stock_market_index_historical_data** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:get_stock_market_index_historical_data) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseStockMarketIndexHistoricalData) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseStockMarketIndexHistoricalData.md) + +[//]: # (OPERATION:get_stock_market_index_historical_data_v2) + +[//]: # (ENDPOINT:/indices/stock_market/{identifier}/historical_data/{tag}) + +[//]: # (DOCUMENT_LINK:IndexApi.md#get_stock_market_index_historical_data) + +## **get_stock_market_index_historical_data** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_stock_market_index_historical_data_v2) + +[//]: # (START_OVERVIEW) + > ApiResponseStockMarketIndexHistoricalData get_stock_market_index_historical_data(identifier, tag, opts) -Historical Data for Stock Market Index +#### Historical Data for Stock Market Index + Returns historical values for the given `tag` and the Stock Market Index with the given `identifier` +[//]: # (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 index_api = Intrinio::IndexApi.new identifier = "$DJI" # String | An Index Identifier (symbol, Intrinio ID) @@ -671,42 +1295,84 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_stock_market_index_historical_data: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | - **tag** | **String**| An Intrinio data tag ID or code-name | - **type** | **String**| Filter by type, when applicable | [optional] - **start_date** | **Date**| Get historical data on or after this date | [optional] - **end_date** | **Date**| Get historical data on or before this date | [optional] - **sort_order** | **String**| Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; | [optional] [default to desc] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| An Index Identifier (symbol, Intrinio ID) | &nbsp; + **tag** | String| An Intrinio data tag ID or code-name | &nbsp; + **type** | String| Filter by type, when applicable | [optional] &nbsp; + **start_date** | Date| Get historical data on or after this date | [optional] &nbsp; + **end_date** | Date| Get historical data on or before this date | [optional] &nbsp; + **sort_order** | String| Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; | [optional] [default to desc] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseStockMarketIndexHistoricalData**](ApiResponseStockMarketIndexHistoricalData.md) -# **search_economic_indices** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:search_economic_indices) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseEconomicIndicesSearch) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseEconomicIndicesSearch.md) + +[//]: # (OPERATION:search_economic_indices_v2) + +[//]: # (ENDPOINT:/indices/economic/search) + +[//]: # (DOCUMENT_LINK:IndexApi.md#search_economic_indices) + +## **search_economic_indices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_economic_indices_v2) + +[//]: # (START_OVERVIEW) + > ApiResponseEconomicIndicesSearch search_economic_indices(query, opts) -Search Economic Indices +#### Search Economic Indices + Searches for indices using the text in `query` +[//]: # (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 index_api = Intrinio::IndexApi.new query = "GDP" # String | Search query @@ -721,36 +1387,78 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->search_economic_indices: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **query** | **String**| Search query | - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] + **query** | String| Search query | &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseEconomicIndicesSearch**](ApiResponseEconomicIndicesSearch.md) -# **search_sic_indices** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:search_sic_indices) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSICIndicesSearch) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSICIndicesSearch.md) + +[//]: # (OPERATION:search_sic_indices_v2) + +[//]: # (ENDPOINT:/indices/sic/search) + +[//]: # (DOCUMENT_LINK:IndexApi.md#search_sic_indices) + +## **search_sic_indices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_sic_indices_v2) + +[//]: # (START_OVERVIEW) + > ApiResponseSICIndicesSearch search_sic_indices(query, opts) -Search SIC Indices +#### Search SIC Indices + Searches for indices using the text in `query` +[//]: # (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 index_api = Intrinio::IndexApi.new query = "agriculture" # String | Search query @@ -765,36 +1473,78 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->search_sic_indices: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **query** | **String**| Search query | - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] + **query** | String| Search query | &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSICIndicesSearch**](ApiResponseSICIndicesSearch.md) -# **search_stock_markets_indices** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::IndexApi) + +[//]: # (METHOD:search_stock_markets_indices) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseStockMarketIndicesSearch) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseStockMarketIndicesSearch.md) + +[//]: # (OPERATION:search_stock_markets_indices_v2) + +[//]: # (ENDPOINT:/indices/stock_market/search) + +[//]: # (DOCUMENT_LINK:IndexApi.md#search_stock_markets_indices) + +## **search_stock_markets_indices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_stock_markets_indices_v2) + +[//]: # (START_OVERVIEW) + > ApiResponseStockMarketIndicesSearch search_stock_markets_indices(query, opts) -Search Stock Market Indices +#### Search Stock Market Indices + Searches for indices using the text in `query` +[//]: # (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 index_api = Intrinio::IndexApi.new query = "dow" # String | Search query @@ -809,16 +1559,28 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->search_stock_markets_indices: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **query** | **String**| Search query | - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] + **query** | String| Search query | &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseStockMarketIndicesSearch**](ApiResponseStockMarketIndicesSearch.md) + +[//]: # (END_OPERATION)