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

- old
+ new

@@ -22,29 +22,16 @@ [**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 - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/economic) - -[//]: # (DOC_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) - > ApiResponseEconomicIndices get_all_economic_indices(opts) All Economic Indices ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -65,12 +52,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_all_economic_indices: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| The number of results to return | [optional] [default to 100] @@ -78,31 +63,16 @@ ### Return type [**ApiResponseEconomicIndices**](ApiResponseEconomicIndices.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/sic) - -[//]: # (DOC_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) - > ApiResponseSICIndices get_all_sic_indices(opts) All SIC Indices ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -123,12 +93,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_all_sic_indices: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| The number of results to return | [optional] [default to 100] @@ -136,31 +104,16 @@ ### Return type [**ApiResponseSICIndices**](ApiResponseSICIndices.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/stock_market) - -[//]: # (DOC_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) - > ApiResponseStockMarketIndices get_all_stock_market_indices(opts) All Stock Market Indices ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -181,12 +134,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_all_stock_market_indices: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| The number of results to return | [optional] [default to 100] @@ -194,31 +145,16 @@ ### Return type [**ApiResponseStockMarketIndices**](ApiResponseStockMarketIndices.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/economic/{identifier}) - -[//]: # (DOC_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) - > EconomicIndex get_economic_index_by_id(identifier) Lookup Economic Index ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -237,45 +173,28 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_economic_index_by_id: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | ### Return type [**EconomicIndex**](EconomicIndex.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/economic/{identifier}/data_point/{tag}/number) - -[//]: # (DOC_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) - > Float get_economic_index_data_point_number(identifier, tag) Data Point (Number) for an Economic Index Returns a numeric value for the given `tag` for the Economic Index with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -296,12 +215,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_economic_index_data_point_number: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | @@ -309,33 +226,18 @@ ### Return type **Float** -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/economic/{identifier}/data_point/{tag}/text) - -[//]: # (DOC_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) - > String get_economic_index_data_point_text(identifier, tag) Data Point (Text) for an Economic Index Returns a text value for the given `tag` for the Economic Index with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -356,12 +258,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_economic_index_data_point_text: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | @@ -369,33 +269,18 @@ ### Return type **String** -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/economic/{identifier}/historical_data/{tag}) - -[//]: # (DOC_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) - > ApiResponseEconomicIndexHistoricalData get_economic_index_historical_data(identifier, tag, opts) Historical Data for an Economic Index Returns historical values for the given `tag` and the Economic Index with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -424,12 +309,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_economic_index_historical_data: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | @@ -443,31 +326,16 @@ ### Return type [**ApiResponseEconomicIndexHistoricalData**](ApiResponseEconomicIndexHistoricalData.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/sic/{identifier}) - -[//]: # (DOC_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) - > SICIndex get_sic_index_by_id(identifier) Lookup SIC Index ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -486,45 +354,28 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_sic_index_by_id: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | ### Return type [**SICIndex**](SICIndex.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/sic/{identifier}/data_point/{tag}/number) - -[//]: # (DOC_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) - > Float get_sic_index_data_point_number(identifier, tag) Data Point (Number) for an SIC Index Returns a numeric value for the given `tag` for the SIC Index with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -545,12 +396,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_sic_index_data_point_number: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | @@ -558,33 +407,18 @@ ### Return type **Float** -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/sic/{identifier}/data_point/{tag}/text) - -[//]: # (DOC_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) - > String get_sic_index_data_point_text(identifier, tag) Data Point (Text) for an SIC Index Returns a text value for the given `tag` for the SIC Index with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -605,12 +439,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_sic_index_data_point_text: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | @@ -618,33 +450,18 @@ ### Return type **String** -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/sic/{identifier}/historical_data/{tag}) - -[//]: # (DOC_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) - > ApiResponseSICIndexHistoricalData get_sic_index_historical_data(identifier, tag, opts) Historical Data for an SIC Index Returns historical values for the given `tag` and the SIC Index with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -673,12 +490,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_sic_index_historical_data: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | @@ -692,31 +507,16 @@ ### Return type [**ApiResponseSICIndexHistoricalData**](ApiResponseSICIndexHistoricalData.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/stock_market/{identifier}) - -[//]: # (DOC_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) - > StockMarketIndex get_stock_market_index_by_id(identifier) Lookup Stock Market Index ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -735,45 +535,28 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_stock_market_index_by_id: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | ### Return type [**StockMarketIndex**](StockMarketIndex.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/stock_market/{identifier}/data_point/{tag}/number) - -[//]: # (DOC_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) - > Float get_stock_market_index_data_point_number(identifier, tag) Data Point (Number) for Stock Market Index Returns a numeric value for the given `tag` for the Stock Market Index with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -794,12 +577,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_stock_market_index_data_point_number: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | @@ -807,33 +588,18 @@ ### Return type **Float** -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/stock_market/{identifier}/data_point/{tag}/text) - -[//]: # (DOC_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) - > String get_stock_market_index_data_point_text(identifier, tag) Data Point (Text) for Stock Market Index Returns a text value for the given `tag` for the Stock Market Index with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -854,12 +620,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_stock_market_index_data_point_text: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | @@ -867,33 +631,18 @@ ### Return type **String** -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/stock_market/{identifier}/historical_data/{tag}) - -[//]: # (DOC_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) - > ApiResponseStockMarketIndexHistoricalData get_stock_market_index_historical_data(identifier, tag, opts) Historical Data for Stock Market Index Returns historical values for the given `tag` and the Stock Market Index with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -922,12 +671,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_stock_market_index_historical_data: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | @@ -941,33 +688,18 @@ ### Return type [**ApiResponseStockMarketIndexHistoricalData**](ApiResponseStockMarketIndexHistoricalData.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/economic/search) - -[//]: # (DOC_LINK:IndexApi.md#search_economic_indices) - # **search_economic_indices** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_economic_indices_v2) - > ApiResponseEconomicIndicesSearch search_economic_indices(query, opts) Search Economic Indices Searches for indices using the text in `query` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -989,12 +721,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->search_economic_indices: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| Search query | @@ -1002,33 +732,18 @@ ### Return type [**ApiResponseEconomicIndicesSearch**](ApiResponseEconomicIndicesSearch.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/sic/search) - -[//]: # (DOC_LINK:IndexApi.md#search_sic_indices) - # **search_sic_indices** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_sic_indices_v2) - > ApiResponseSICIndicesSearch search_sic_indices(query, opts) Search SIC Indices Searches for indices using the text in `query` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1050,12 +765,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->search_sic_indices: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| Search query | @@ -1063,33 +776,18 @@ ### Return type [**ApiResponseSICIndicesSearch**](ApiResponseSICIndicesSearch.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/indices/stock_market/search) - -[//]: # (DOC_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) - > ApiResponseStockMarketIndicesSearch search_stock_markets_indices(query, opts) Search Stock Market Indices Searches for indices using the text in `query` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1111,20 +809,16 @@ rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->search_stock_markets_indices: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| Search query | **page_size** | **Integer**| The number of results to return | [optional] [default to 100] ### Return type [**ApiResponseStockMarketIndicesSearch**](ApiResponseStockMarketIndicesSearch.md) - -[//]: # (END_OPERATION)