intrinio-sdk 5.3.0 → 5.6.3

data/docs/HistoricalDataApi.md

@@ -53,30 +53,25 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 historicalData_api = Intrinio::HistoricalDataApi.new
-
-identifier = "AAPL" # String | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
-
-tag = "marketcap" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
-
-opts = { 
-  frequency: "daily", # String | Return historical data in the given frequency
-  type: nil, # String | Filter by type, when applicable
-  start_date: Date.parse("2015-01-01"), # Date | Get historical data on or after this date
-  end_date: nil, # Date | Get historical date on or before this date
-  sort_order: "desc", # String | Sort by date `asc` or `desc`
-  page_size: 100, # Integer | The number of results to return
-  next_page: nil # String | Gets the next page of data from a previous API call
+identifier = "AAPL"
+tag = "marketcap"
+
+opts = {
+  frequency: "daily",
+  type: nil,
+  start_date: Date.parse("2015-01-01"),
+  end_date: nil,
+  sort_order: "desc",
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = historicalData_api.get_historical_data(identifier, tag, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling HistoricalDataApi->get_historical_data: #{e}"
-end
+result = historicalData_api.get_historical_data(identifier, tag, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)

data/docs/IndexApi.md

@@ -69,21 +69,18 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
 
-opts = { 
-  page_size: 100, # Integer | The number of results to return
-  next_page: nil # String | Gets the next page of data from a previous API call
+opts = {
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = index_api.get_all_economic_indices(opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->get_all_economic_indices: #{e}"
-end
+result = index_api.get_all_economic_indices(opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -153,21 +150,18 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
 
-opts = { 
-  page_size: 100, # Integer | The number of results to return
-  next_page: nil # String | Gets the next page of data from a previous API call
+opts = {
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = index_api.get_all_sic_indices(opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->get_all_sic_indices: #{e}"
-end
+result = index_api.get_all_sic_indices(opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -237,21 +231,18 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
 
-opts = { 
-  page_size: 100, # Integer | The number of results to return
-  next_page: nil # String | Gets the next page of data from a previous API call
+opts = {
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = index_api.get_all_stock_market_indices(opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->get_all_stock_market_indices: #{e}"
-end
+result = index_api.get_all_stock_market_indices(opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -321,19 +312,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
+identifier = "$GDP"
 
-identifier = "$GDP" # String | An Index Identifier (symbol, Intrinio ID)
-
-
-begin
-  result = index_api.get_economic_index_by_id(identifier)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->get_economic_index_by_id: #{e}"
-end
+result = index_api.get_economic_index_by_id(identifier)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -403,21 +389,15 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
+identifier = "$GDP"
+tag = "level"
 
-identifier = "$GDP" # String | An Index Identifier (symbol, Intrinio ID)
-
-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)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->get_economic_index_data_point_number: #{e}"
-end
+result = index_api.get_economic_index_data_point_number(identifier, tag)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -488,21 +468,15 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
+identifier = "$GDP"
+tag = "level"
 
-identifier = "$GDP" # String | An Index Identifier (symbol, Intrinio ID)
-
-tag = "level" # String | An Intrinio data tag ID or code-name
-
-
-begin
-  result = index_api.get_economic_index_data_point_text(identifier, tag)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->get_economic_index_data_point_text: #{e}"
-end
+result = index_api.get_economic_index_data_point_text(identifier, tag)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -573,29 +547,24 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
-
-identifier = "$GDP" # String | An Index Identifier (symbol, Intrinio ID)
-
-tag = "level" # String | An Intrinio data tag <a href='https://data.intrinio.com/data-tags/economic'>reference</a>
-
-opts = { 
-  type: nil, # String | Filter by type, when applicable
-  start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
-  end_date: nil, # Date | Get historical data on or before this date
-  sort_order: "desc", # String | Sort by date `asc` or `desc`
-  page_size: 100, # Integer | The number of results to return
-  next_page: nil # String | Gets the next page of data from a previous API call
+identifier = "$GDP"
+tag = "level"
+
+opts = {
+  type: nil,
+  start_date: Date.parse("2018-01-01"),
+  end_date: nil,
+  sort_order: "desc",
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = index_api.get_economic_index_historical_data(identifier, tag, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->get_economic_index_historical_data: #{e}"
-end
+result = index_api.get_economic_index_historical_data(identifier, tag, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -671,19 +640,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
+identifier = "$SIC.2911"
 
-identifier = "$SIC.1" # String | An Index Identifier (symbol, Intrinio ID)
-
-
-begin
-  result = index_api.get_sic_index_by_id(identifier)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->get_sic_index_by_id: #{e}"
-end
+result = index_api.get_sic_index_by_id(identifier)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -753,21 +717,15 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
+identifier = "$SIC.2911"
+tag = "marketcap"
 
-identifier = "$SIC.1" # String | An Index Identifier (symbol, Intrinio ID)
-
-tag = "level" # String | An Intrinio data tag ID or code-name
-
-
-begin
-  result = index_api.get_sic_index_data_point_number(identifier, tag)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->get_sic_index_data_point_number: #{e}"
-end
+result = index_api.get_sic_index_data_point_number(identifier, tag)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -838,21 +796,15 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
+identifier = "$SIC.2911"
+tag = "marketcap"
 
-identifier = "$SIC.1" # String | An Index Identifier (symbol, Intrinio ID)
-
-tag = "level" # String | An Intrinio data tag ID or code-name
-
-
-begin
-  result = index_api.get_sic_index_data_point_text(identifier, tag)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->get_sic_index_data_point_text: #{e}"
-end
+result = index_api.get_sic_index_data_point_text(identifier, tag)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -923,29 +875,24 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
-
-identifier = "$SIC.1" # String | An Index Identifier (symbol, Intrinio ID)
-
-tag = "marketcap" # String | An Intrinio data tag ID or code-name
-
-opts = { 
-  type: nil, # String | Filter by type, when applicable
-  start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
-  end_date: nil, # Date | Get historical data on or before this date
-  sort_order: "desc", # String | Sort by date `asc` or `desc`
-  page_size: 100, # Integer | The number of results to return
-  next_page: nil # String | Gets the next page of data from a previous API call
+identifier = "$SIC.1"
+tag = "marketcap"
+
+opts = {
+  type: nil,
+  start_date: Date.parse("2018-01-01"),
+  end_date: nil,
+  sort_order: "desc",
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = index_api.get_sic_index_historical_data(identifier, tag, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->get_sic_index_historical_data: #{e}"
-end
+result = index_api.get_sic_index_historical_data(identifier, tag, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -1021,19 +968,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
+identifier = "$DJI"
 
-identifier = "$DJI" # String | An Index Identifier (symbol, Intrinio ID)
-
-
-begin
-  result = index_api.get_stock_market_index_by_id(identifier)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->get_stock_market_index_by_id: #{e}"
-end
+result = index_api.get_stock_market_index_by_id(identifier)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -1103,21 +1045,15 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
+identifier = "$DJI"
+tag = "level"
 
-identifier = "$DJI" # String | An Index Identifier (symbol, Intrinio ID)
-
-tag = "level" # String | An Intrinio data tag ID or code-name
-
-
-begin
-  result = index_api.get_stock_market_index_data_point_number(identifier, tag)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->get_stock_market_index_data_point_number: #{e}"
-end
+result = index_api.get_stock_market_index_data_point_number(identifier, tag)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -1188,21 +1124,15 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
+identifier = "$DJI"
+tag = "level"
 
-identifier = "$DJI" # String | An Index Identifier (symbol, Intrinio ID)
-
-tag = "level" # String | An Intrinio data tag ID or code-name
-
-
-begin
-  result = index_api.get_stock_market_index_data_point_text(identifier, tag)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->get_stock_market_index_data_point_text: #{e}"
-end
+result = index_api.get_stock_market_index_data_point_text(identifier, tag)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -1273,29 +1203,24 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
-
-identifier = "$DJI" # String | An Index Identifier (symbol, Intrinio ID)
-
-tag = "level" # String | An Intrinio data tag ID or code-name
-
-opts = { 
-  type: nil, # String | Filter by type, when applicable
-  start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
-  end_date: nil, # Date | Get historical data on or before this date
-  sort_order: "desc", # String | Sort by date `asc` or `desc`
-  page_size: 100, # Integer | The number of results to return
-  next_page: nil # String | Gets the next page of data from a previous API call
+identifier = "$DJI"
+tag = "level"
+
+opts = {
+  type: nil,
+  start_date: Date.parse("2018-01-01"),
+  end_date: nil,
+  sort_order: "desc",
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = index_api.get_stock_market_index_historical_data(identifier, tag, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->get_stock_market_index_historical_data: #{e}"
-end
+result = index_api.get_stock_market_index_historical_data(identifier, tag, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -1372,22 +1297,18 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
+query = "GDP"
 
-query = "GDP" # String | Search query
-
-opts = { 
-  page_size: 100 # Integer | The number of results to return
+opts = {
+  page_size: 100
 }
 
-begin
-  result = index_api.search_economic_indices(query, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->search_economic_indices: #{e}"
-end
+result = index_api.search_economic_indices(query, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -1458,22 +1379,18 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
+query = "agriculture"
 
-query = "agriculture" # String | Search query
-
-opts = { 
-  page_size: 100 # Integer | The number of results to return
+opts = {
+  page_size: 100
 }
 
-begin
-  result = index_api.search_sic_indices(query, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->search_sic_indices: #{e}"
-end
+result = index_api.search_sic_indices(query, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -1544,22 +1461,18 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 index_api = Intrinio::IndexApi.new
+query = "dow"
 
-query = "dow" # String | Search query
-
-opts = { 
-  page_size: 100 # Integer | The number of results to return
+opts = {
+  page_size: 100
 }
 
-begin
-  result = index_api.search_stock_markets_indices(query, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling IndexApi->search_stock_markets_indices: #{e}"
-end
+result = index_api.search_stock_markets_indices(query, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)