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

- old
+ new

@@ -43,11 +43,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_economic_indices_v2) [//]: # (START_OVERVIEW) > ApiResponseEconomicIndices get_all_economic_indices(opts) @@ -62,10 +62,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -77,11 +78,11 @@ next_page: nil # String | Gets the next page of data from a previous API call } begin result = index_api.get_all_economic_indices(opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_all_economic_indices: #{e}" end ``` @@ -127,11 +128,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_sic_indices_v2) [//]: # (START_OVERVIEW) > ApiResponseSICIndices get_all_sic_indices(opts) @@ -146,10 +147,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -161,11 +163,11 @@ next_page: nil # String | Gets the next page of data from a previous API call } begin result = index_api.get_all_sic_indices(opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_all_sic_indices: #{e}" end ``` @@ -211,11 +213,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_stock_market_indices_v2) [//]: # (START_OVERVIEW) > ApiResponseStockMarketIndices get_all_stock_market_indices(opts) @@ -230,10 +232,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -245,11 +248,11 @@ next_page: nil # String | Gets the next page of data from a previous API call } begin result = index_api.get_all_stock_market_indices(opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_all_stock_market_indices: #{e}" end ``` @@ -295,11 +298,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_economic_index_by_id_v2) [//]: # (START_OVERVIEW) > EconomicIndex get_economic_index_by_id(identifier) @@ -314,10 +317,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -327,11 +331,11 @@ identifier = "$GDP" # String | An Index Identifier (symbol, Intrinio ID) begin result = index_api.get_economic_index_by_id(identifier) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_economic_index_by_id: #{e}" end ``` @@ -376,11 +380,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_economic_index_data_point_number_v2) [//]: # (START_OVERVIEW) > Float get_economic_index_data_point_number(identifier, tag) @@ -396,10 +400,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -411,11 +416,11 @@ tag = "level" # String | An Intrinio data tag <a href='https://data.intrinio.com/data-tags/economic'>reference</a> begin result = index_api.get_economic_index_data_point_number(identifier, tag) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_economic_index_data_point_number: #{e}" end ``` @@ -461,11 +466,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_economic_index_data_point_text_v2) [//]: # (START_OVERVIEW) > String get_economic_index_data_point_text(identifier, tag) @@ -481,10 +486,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -496,11 +502,11 @@ tag = "level" # String | An Intrinio data tag ID or code-name begin result = index_api.get_economic_index_data_point_text(identifier, tag) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_economic_index_data_point_text: #{e}" end ``` @@ -546,11 +552,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_economic_index_historical_data_v2) [//]: # (START_OVERVIEW) > ApiResponseEconomicIndexHistoricalData get_economic_index_historical_data(identifier, tag, opts) @@ -566,10 +572,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -589,11 +596,11 @@ next_page: nil # String | Gets the next page of data from a previous API call } begin result = index_api.get_economic_index_historical_data(identifier, tag, opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_economic_index_historical_data: #{e}" end ``` @@ -645,11 +652,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_sic_index_by_id_v2) [//]: # (START_OVERVIEW) > SICIndex get_sic_index_by_id(identifier) @@ -664,10 +671,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -677,11 +685,11 @@ identifier = "$SIC.1" # String | An Index Identifier (symbol, Intrinio ID) begin result = index_api.get_sic_index_by_id(identifier) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_sic_index_by_id: #{e}" end ``` @@ -726,11 +734,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_sic_index_data_point_number_v2) [//]: # (START_OVERVIEW) > Float get_sic_index_data_point_number(identifier, tag) @@ -746,10 +754,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -761,11 +770,11 @@ tag = "level" # String | An Intrinio data tag ID or code-name begin result = index_api.get_sic_index_data_point_number(identifier, tag) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_sic_index_data_point_number: #{e}" end ``` @@ -811,11 +820,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_sic_index_data_point_text_v2) [//]: # (START_OVERVIEW) > String get_sic_index_data_point_text(identifier, tag) @@ -831,10 +840,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -846,11 +856,11 @@ tag = "level" # String | An Intrinio data tag ID or code-name begin result = index_api.get_sic_index_data_point_text(identifier, tag) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_sic_index_data_point_text: #{e}" end ``` @@ -896,11 +906,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_sic_index_historical_data_v2) [//]: # (START_OVERVIEW) > ApiResponseSICIndexHistoricalData get_sic_index_historical_data(identifier, tag, opts) @@ -916,10 +926,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -939,11 +950,11 @@ next_page: nil # String | Gets the next page of data from a previous API call } begin result = index_api.get_sic_index_historical_data(identifier, tag, opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_sic_index_historical_data: #{e}" end ``` @@ -995,11 +1006,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_stock_market_index_by_id_v2) [//]: # (START_OVERVIEW) > StockMarketIndex get_stock_market_index_by_id(identifier) @@ -1014,10 +1025,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -1027,11 +1039,11 @@ identifier = "$DJI" # String | An Index Identifier (symbol, Intrinio ID) begin result = index_api.get_stock_market_index_by_id(identifier) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_stock_market_index_by_id: #{e}" end ``` @@ -1076,11 +1088,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_stock_market_index_data_point_number_v2) [//]: # (START_OVERVIEW) > Float get_stock_market_index_data_point_number(identifier, tag) @@ -1096,10 +1108,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -1111,11 +1124,11 @@ tag = "level" # String | An Intrinio data tag ID or code-name begin result = index_api.get_stock_market_index_data_point_number(identifier, tag) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_stock_market_index_data_point_number: #{e}" end ``` @@ -1161,11 +1174,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_stock_market_index_data_point_text_v2) [//]: # (START_OVERVIEW) > String get_stock_market_index_data_point_text(identifier, tag) @@ -1181,10 +1194,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -1196,11 +1210,11 @@ tag = "level" # String | An Intrinio data tag ID or code-name begin result = index_api.get_stock_market_index_data_point_text(identifier, tag) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_stock_market_index_data_point_text: #{e}" end ``` @@ -1246,11 +1260,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_stock_market_index_historical_data_v2) [//]: # (START_OVERVIEW) > ApiResponseStockMarketIndexHistoricalData get_stock_market_index_historical_data(identifier, tag, opts) @@ -1266,10 +1280,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -1289,11 +1304,11 @@ next_page: nil # String | Gets the next page of data from a previous API call } begin result = index_api.get_stock_market_index_historical_data(identifier, tag, opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->get_stock_market_index_historical_data: #{e}" end ``` @@ -1345,11 +1360,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/search_economic_indices_v2) [//]: # (START_OVERVIEW) > ApiResponseEconomicIndicesSearch search_economic_indices(query, opts) @@ -1365,10 +1380,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -1381,11 +1397,11 @@ page_size: 100 # Integer | The number of results to return } begin result = index_api.search_economic_indices(query, opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->search_economic_indices: #{e}" end ``` @@ -1431,11 +1447,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/search_sic_indices_v2) [//]: # (START_OVERVIEW) > ApiResponseSICIndicesSearch search_sic_indices(query, opts) @@ -1451,10 +1467,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -1467,11 +1484,11 @@ page_size: 100 # Integer | The number of results to return } begin result = index_api.search_sic_indices(query, opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->search_sic_indices: #{e}" end ``` @@ -1517,11 +1534,11 @@ [//]: # (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) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/search_stock_markets_indices_v2) [//]: # (START_OVERVIEW) > ApiResponseStockMarketIndicesSearch search_stock_markets_indices(query, opts) @@ -1537,10 +1554,11 @@ [//]: # (START_CODE_EXAMPLE) ```ruby # Load the gem require 'intrinio-sdk' +require 'pp' # Setup authorization Intrinio.configure do |config| config.api_key['api_key'] = 'YOUR_API_KEY' end @@ -1553,10 +1571,10 @@ page_size: 100 # Integer | The number of results to return } begin result = index_api.search_stock_markets_indices(query, opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling IndexApi->search_stock_markets_indices: #{e}" end ```