intrinio-sdk 6.27.2 → 6.27.4

data/docs/IndexApi.md

@@ -5,13 +5,18 @@ All URIs are relative to *https://api-v2.intrinio.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_all_economic_indices**](IndexApi.md#get_all_economic_indices) | **GET** /indices/economic | All Economic Indices
+[**get_all_eod_index_prices**](IndexApi.md#get_all_eod_index_prices) | **GET** /indices/prices/eod | All End of Day Index Prices
+[**get_all_index_summaries**](IndexApi.md#get_all_index_summaries) | **GET** /indices | All Index Summaries
+[**get_all_realtime_index_prices**](IndexApi.md#get_all_realtime_index_prices) | **GET** /indices/prices/realtime | All Realtime Index Prices
 [**get_all_sic_indices**](IndexApi.md#get_all_sic_indices) | **GET** /indices/sic | All SIC Indices
 [**get_all_stock_market_indices**](IndexApi.md#get_all_stock_market_indices) | **GET** /indices/stock_market | All Stock Market Indices
 [**get_economic_index_by_id**](IndexApi.md#get_economic_index_by_id) | **GET** /indices/economic/{identifier} | Lookup Economic Index
 [**get_economic_index_data_point_number**](IndexApi.md#get_economic_index_data_point_number) | **GET** /indices/economic/{identifier}/data_point/{tag}/number | Data Point (Number) for an Economic Index
 [**get_economic_index_data_point_text**](IndexApi.md#get_economic_index_data_point_text) | **GET** /indices/economic/{identifier}/data_point/{tag}/text | Data Point (Text) for an Economic Index
 [**get_economic_index_historical_data**](IndexApi.md#get_economic_index_historical_data) | **GET** /indices/economic/{identifier}/historical_data/{tag} | Historical Data for an Economic Index
-[**get_realtime_index_price_by_id**](IndexApi.md#get_realtime_index_price_by_id) | **GET** /indices/{identifier}/realtime | Realtime Index Price
+[**get_eod_index_price_by_id**](IndexApi.md#get_eod_index_price_by_id) | **GET** /indices/{identifier}/eod | End of Day Index Prices By Identifier
+[**get_index_summary_by_id**](IndexApi.md#get_index_summary_by_id) | **GET** /indices/{identifier} | Index Summary By Identifier
+[**get_realtime_index_price_by_id**](IndexApi.md#get_realtime_index_price_by_id) | **GET** /indices/{identifier}/realtime | Realtime Index Price By Identifier
 [**get_sic_index_by_id**](IndexApi.md#get_sic_index_by_id) | **GET** /indices/sic/{identifier} | Lookup SIC Index
 [**get_sic_index_data_point_number**](IndexApi.md#get_sic_index_data_point_number) | **GET** /indices/sic/{identifier}/data_point/{tag}/number | Data Point (Number) for an SIC Index
 [**get_sic_index_data_point_text**](IndexApi.md#get_sic_index_data_point_text) | **GET** /indices/sic/{identifier}/data_point/{tag}/text | Data Point (Text) for an SIC Index
@@ -108,6 +113,247 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::IndexApi)
+
+[//]: # (METHOD:get_all_eod_index_prices)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseEodIndexPricesAll)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseEodIndexPricesAll.md)
+
+[//]: # (OPERATION:get_all_eod_index_prices_v2)
+
+[//]: # (ENDPOINT:/indices/prices/eod)
+
+[//]: # (DOCUMENT_LINK:IndexApi.md#get_all_eod_index_prices)
+
+## **get_all_eod_index_prices**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_eod_index_prices_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseEodIndexPricesAll get_all_eod_index_prices(opts)
+
+#### All End of Day Index Prices
+
+
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (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'
+  config.allow_retries = true
+end
+
+index_api = Intrinio::IndexApi.new
+
+opts = {
+  page_size: 100,
+  start_date: nil,
+  end_date: nil
+}
+
+result = index_api.get_all_eod_index_prices(opts)
+pp result
+```
+
+[//]: # (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]  
+ **start_date** | Date| Limit prices to those on or after this date | [optional]   
+ **end_date** | Date| Limit prices to those on or before this date | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseEodIndexPricesAll**](ApiResponseEodIndexPricesAll.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::IndexApi)
+
+[//]: # (METHOD:get_all_index_summaries)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseIndices)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseIndices.md)
+
+[//]: # (OPERATION:get_all_index_summaries_v2)
+
+[//]: # (ENDPOINT:/indices)
+
+[//]: # (DOCUMENT_LINK:IndexApi.md#get_all_index_summaries)
+
+## **get_all_index_summaries**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_index_summaries_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseIndices get_all_index_summaries(opts)
+
+#### All Index Summaries
+
+
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (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'
+  config.allow_retries = true
+end
+
+index_api = Intrinio::IndexApi.new
+
+opts = {
+  page_size: 100
+}
+
+result = index_api.get_all_index_summaries(opts)
+pp result
+```
+
+[//]: # (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]  
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseIndices**](ApiResponseIndices.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::IndexApi)
+
+[//]: # (METHOD:get_all_realtime_index_prices)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseRealtimeIndexPrices)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseRealtimeIndexPrices.md)
+
+[//]: # (OPERATION:get_all_realtime_index_prices_v2)
+
+[//]: # (ENDPOINT:/indices/prices/realtime)
+
+[//]: # (DOCUMENT_LINK:IndexApi.md#get_all_realtime_index_prices)
+
+## **get_all_realtime_index_prices**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_realtime_index_prices_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseRealtimeIndexPrices get_all_realtime_index_prices(opts)
+
+#### All Realtime Index Prices
+
+
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (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'
+  config.allow_retries = true
+end
+
+index_api = Intrinio::IndexApi.new
+
+opts = {
+  page_size: 100
+}
+
+result = index_api.get_all_realtime_index_prices(opts)
+pp result
+```
+
+[//]: # (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]  
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseRealtimeIndexPrices**](ApiResponseRealtimeIndexPrices.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::IndexApi)
@@ -599,6 +845,167 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::IndexApi)
+
+[//]: # (METHOD:get_eod_index_price_by_id)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseEodIndexPrices)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseEodIndexPrices.md)
+
+[//]: # (OPERATION:get_eod_index_price_by_id_v2)
+
+[//]: # (ENDPOINT:/indices/{identifier}/eod)
+
+[//]: # (DOCUMENT_LINK:IndexApi.md#get_eod_index_price_by_id)
+
+## **get_eod_index_price_by_id**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_eod_index_price_by_id_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseEodIndexPrices get_eod_index_price_by_id(identifier, opts)
+
+#### End of Day Index Prices By Identifier
+
+
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (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'
+  config.allow_retries = true
+end
+
+index_api = Intrinio::IndexApi.new
+identifier = "SPX"
+
+opts = {
+  page_size: 100,
+  start_date: nil,
+  end_date: nil
+}
+
+result = index_api.get_eod_index_price_by_id(identifier, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| The index symbol |   
+ **page_size** | Integer| The number of results to return | [optional] [default to 100]  
+ **start_date** | Date| Limit prices to those on or after this date | [optional]   
+ **end_date** | Date| Limit prices to those on or before this date | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseEodIndexPrices**](ApiResponseEodIndexPrices.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::IndexApi)
+
+[//]: # (METHOD:get_index_summary_by_id)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseIndex)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseIndex.md)
+
+[//]: # (OPERATION:get_index_summary_by_id_v2)
+
+[//]: # (ENDPOINT:/indices/{identifier})
+
+[//]: # (DOCUMENT_LINK:IndexApi.md#get_index_summary_by_id)
+
+## **get_index_summary_by_id**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_index_summary_by_id_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseIndex get_index_summary_by_id(identifier)
+
+#### Index Summary By Identifier
+
+
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (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'
+  config.allow_retries = true
+end
+
+index_api = Intrinio::IndexApi.new
+identifier = "SPX"
+
+result = index_api.get_index_summary_by_id(identifier)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| The index symbol |   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseIndex**](ApiResponseIndex.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::IndexApi)
@@ -625,7 +1032,7 @@ Name | Type | Description  | Notes
 
 > RealtimeIndexPrice get_realtime_index_price_by_id(identifier)
 
-#### Realtime Index Price
+#### Realtime Index Price By Identifier
 
 
 
@@ -664,7 +1071,7 @@ pp result
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **identifier** | String| The ticker symbol of the currently trading index |   
+ **identifier** | String| The index symbol |   
 
 [//]: # (END_PARAMETERS)
 

data/docs/OptionFactorsRealtime.md

@@ -17,7 +17,7 @@ Name | Type | Description
 **strike_price** | Float | The strike price of the options contract  
 **days_to_expiration** | Float | The number of days to expiration  
 **risk_free_interest_rate** | Float | The current risk-free interest rate, as measured by the 3-month Treasury Bill rate  
-**dividend_yield** | Float | The divident yield of the underlying asset (if applicable)  
+**dividend_yield** | Float | The dividend yield of the underlying asset (if applicable)  
 
 [//]: # (END_DEFINITION)
 

data/docs/OptionsAggregate.md

@@ -0,0 +1,22 @@
+
+
+[//]: # (CLASS:Intrinio::OptionsAggregate)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionsAggregate
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**ticker** | String | The ticker symbol of the Security for the Option.  
+**total_open_interest** | Float | Total open interest for the ticker  
+**total_volume** | Float | Total volume for the ticker  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OptionsApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api-v2.intrinio.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_all_options_tickers**](OptionsApi.md#get_all_options_tickers) | **GET** /options/tickers | Options Tickers
+[**get_option_aggregates**](OptionsApi.md#get_option_aggregates) | **GET** /options/aggregates | Total open interest and volume aggregated by ticker
 [**get_option_expirations_realtime**](OptionsApi.md#get_option_expirations_realtime) | **GET** /options/expirations/{symbol}/realtime | Options Expirations
 [**get_option_strikes_realtime**](OptionsApi.md#get_option_strikes_realtime) | **GET** /options/strikes/{symbol}/{strike}/realtime | Option Strikes Realtime
 [**get_options**](OptionsApi.md#get_options) | **GET** /options/{symbol} | Options
@@ -103,6 +104,86 @@ This endpoint does not need any parameter.
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_option_aggregates)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsAggregates)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsAggregates.md)
+
+[//]: # (OPERATION:get_option_aggregates_v2)
+
+[//]: # (ENDPOINT:/options/aggregates)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_option_aggregates)
+
+## **get_option_aggregates**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_option_aggregates_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsAggregates get_option_aggregates(opts)
+
+#### Total open interest and volume aggregated by ticker
+
+
+Returns total open interest and volume by ticker
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (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'
+  config.allow_retries = true
+end
+
+options_api = Intrinio::OptionsApi.new
+
+opts = {
+  date: "2024-04-24"
+}
+
+result = options_api.get_option_aggregates(opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **date** | [**Object**](.md)| Return aggregated data for this date | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsAggregates**](ApiResponseOptionsAggregates.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::OptionsApi)

data/docs/SecurityApi.md

@@ -1055,6 +1055,7 @@ opts = {
   end_time: nil,
   timezone: "UTC",
   page_size: 100,
+  split_adjusted: false,
   next_page: nil
 }
 
@@ -1082,6 +1083,7 @@ Name | Type | Description  | Notes
  **end_time** | String| Return intervals stopping at the specified time on the `end_date` (24-hour in 'hh:mm:ss' format) | [optional]   
  **timezone** | String| Returns trading times in this timezone | [optional] [default to UTC]  
  **page_size** | Integer| The number of results to return | [optional] [default to 100]  
+ **split_adjusted** | BOOLEAN| Whether to return the values adjusted for splits or not. Default is false. | [optional] [default to false]  
  **next_page** | String| Gets the next page of data from a previous API call | [optional]   
 
 [//]: # (END_PARAMETERS)

data/docs/StockExchangeApi.md

@@ -403,6 +403,7 @@ opts = {
   source: nil,
   active_only: nil,
   page_size: 100,
+  tickers: [nil],
   next_page: nil
 }
 
@@ -425,6 +426,7 @@ Name | Type | Description  | Notes
  **source** | String| Return realtime prices from the specified data source. If no source is specified, all sources are used. | [optional]   
  **active_only** | BOOLEAN| Returns prices only from the most recent trading day. | [optional]   
  **page_size** | Integer| The number of results to return | [optional] [default to 100]  
+ **tickers** | [**Array<String>**](String.md)| The list of ticker symbols to filter to. | [optional]   
  **next_page** | String| Gets the next page of data from a previous API call | [optional]   
 
 [//]: # (END_PARAMETERS)