intrinio-sdk 6.35.0 → 6.36.0

data/docs/OptionsApi.md

@@ -17,6 +17,7 @@ Method | HTTP request | Description
 [**get_options_chain_realtime**](OptionsApi.md#get_options_chain_realtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
 [**get_options_expirations**](OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
 [**get_options_expirations_eod**](OptionsApi.md#get_options_expirations_eod) | **GET** /options/expirations/{symbol}/eod | Options Expirations
+[**get_options_implied_move_by_symbol**](OptionsApi.md#get_options_implied_move_by_symbol) | **GET** /options/implied_move/{symbol}/{expiration_date} | Options Implied Move By Symbol
 [**get_options_interval_by_contract**](OptionsApi.md#get_options_interval_by_contract) | **GET** /options/interval/{identifier} | Options Intervals By Contract
 [**get_options_interval_movers**](OptionsApi.md#get_options_interval_movers) | **GET** /options/interval/movers | Options Intervals Movers
 [**get_options_interval_movers_change**](OptionsApi.md#get_options_interval_movers_change) | **GET** /options/interval/movers/change | Options Intervals Movers By Change
@@ -33,6 +34,8 @@ Method | HTTP request | Description
 [**get_unusual_activity_intraday**](OptionsApi.md#get_unusual_activity_intraday) | **GET** /options/unusual_activity/{symbol}/intraday | Options Unusual Activity Intraday
 [**get_unusual_activity_universal**](OptionsApi.md#get_unusual_activity_universal) | **GET** /options/unusual_activity | Options Unusual Activity Universal
 [**get_unusual_activity_universal_intraday**](OptionsApi.md#get_unusual_activity_universal_intraday) | **GET** /options/unusual_activity/intraday | Options Unusual Activity Universal Intraday
+[**options_greeks_by_ticker_identifier_realtime_get**](OptionsApi.md#options_greeks_by_ticker_identifier_realtime_get) | **GET** /options/greeks/by_ticker/{identifier}/realtime | Get realtime options greeks by ticker
+[**options_greeks_contract_realtime_get**](OptionsApi.md#options_greeks_contract_realtime_get) | **GET** /options/greeks/{contract}/realtime | Get realtime options greeks for a specific contract
 
 
 
@@ -1242,6 +1245,92 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_options_implied_move_by_symbol)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsImpliedMove)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsImpliedMove.md)
+
+[//]: # (OPERATION:get_options_implied_move_by_symbol_v2)
+
+[//]: # (ENDPOINT:/options/implied_move/{symbol}/{expiration_date})
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_implied_move_by_symbol)
+
+## **get_options_implied_move_by_symbol**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_options_implied_move_by_symbol_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsImpliedMove get_options_implied_move_by_symbol(symbol, expiration_date, opts)
+
+#### Options Implied Move By Symbol
+
+
+Returns the implied move data points for a ticker symbol.
+
+[//]: # (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
+symbol = "TSLA"
+expiration_date = Date.parse("2025-05-30")
+
+opts = {
+  percentage: 0.85,
+  source: nil
+}
+
+result = options_api.get_options_implied_move_by_symbol(symbol, expiration_date, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **symbol** | String| The ticker symbol for the contracts. |   
+ **expiration_date** | Date| The expiration date for the contracts to consider. |   
+ **percentage** | [**Object**](.md)| Percentage to multiply the straddle by. Defaults to 0.85. | [optional]   
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsImpliedMove**](ApiResponseOptionsImpliedMove.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::OptionsApi)
@@ -2090,7 +2179,8 @@ opts = {
   model: nil,
   show_extended_price: nil,
   expiration_start_date: "2024-01-01",
-  expiration_end_date: "2024-02-02"
+  expiration_end_date: "2024-02-02",
+  strike: 100.0
 }
 
 result = options_api.get_options_prices_realtime_by_ticker(symbol, opts)
@@ -2118,6 +2208,7 @@ Name | Type | Description  | Notes
  **show_extended_price** | BOOLEAN| Whether to include open close high low type fields. | [optional]   
  **expiration_start_date** | [**Object**](.md)| Filter out contracts that expire before this date. | [optional]   
  **expiration_end_date** | [**Object**](.md)| Filter out contracts that expire after this date. | [optional]   
+ **strike** | Float| Filter out contracts that have this strike price. | [optional]   
 
 [//]: # (END_PARAMETERS)
 
@@ -2465,7 +2556,7 @@ Name | Type | Description  | Notes
  **activity_type** | String| The unusual activity type to query for. | [optional]   
  **sentiment** | String| The sentiment type to query for. | [optional]   
  **start_date** | Date| Return unusual activity on or after this date. | [optional]   
- **end_date** | Date| Return unusual activity on or before this date. | [optional]   
+ **end_date** | Date| Return unusual activity before this date. | [optional]   
  **minimum_total_value** | [**Object**](.md)| The inclusive minimum total value for the unusual activity. | [optional]   
  **maximum_total_value** | [**Object**](.md)| The inclusive maximum total value for the unusual activity. | [optional]   
 
@@ -2639,7 +2730,7 @@ Name | Type | Description  | Notes
  **activity_type** | String| The unusual activity type to query for. | [optional]   
  **sentiment** | String| The sentiment type to query for. | [optional]   
  **start_date** | Date| Return unusual activity on or after this date. | [optional]   
- **end_date** | Date| Return unusual activity on or before this date. | [optional]   
+ **end_date** | Date| Return unusual activity before this date. | [optional]   
  **minimum_total_value** | [**Object**](.md)| The inclusive minimum total value for the unusual activity. | [optional]   
  **maximum_total_value** | [**Object**](.md)| The inclusive maximum total value for the unusual activity. | [optional]   
 
@@ -2651,3 +2742,191 @@ Name | Type | Description  | Notes
 
 [//]: # (END_OPERATION)
 
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:options_greeks_by_ticker_identifier_realtime_get)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsGreeksByTickerRealtime)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsGreeksByTickerRealtime.md)
+
+[//]: # (OPERATION:options_greeks_by_ticker_identifier_realtime_get_v2)
+
+[//]: # (ENDPOINT:/options/greeks/by_ticker/{identifier}/realtime)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#options_greeks_by_ticker_identifier_realtime_get)
+
+## **options_greeks_by_ticker_identifier_realtime_get**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/options_greeks_by_ticker_identifier_realtime_get_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsGreeksByTickerRealtime options_greeks_by_ticker_identifier_realtime_get(identifier, opts)
+
+#### Get realtime options greeks by ticker
+
+
+Retrieves realtime options greeks data for all contracts of a given ticker symbol
+
+[//]: # (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
+identifier = "identifier_example"
+
+opts = {
+  source: "source_example",
+  model: "black_scholes",
+  iv_mode: "iv_mode_example",
+  stock_price_source: "stock_price_source_example",
+  expiration_start_date: Date.parse("2013-10-20"),
+  expiration_end_date: Date.parse("2013-10-20"),
+  strike: 3.4,
+  strike_greater_than: 3.4,
+  strike_less_than: 3.4,
+  page_size: 250
+}
+
+result = options_api.options_greeks_by_ticker_identifier_realtime_get(identifier, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| The ticker symbol to get options greeks for |   
+ **source** | String| The data source to use for options data | [optional]   
+ **model** | String| The options pricing model to use for greeks calculations | [optional] [default to black_scholes]  
+ **iv_mode** | String| The implied volatility calculation mode | [optional]   
+ **stock_price_source** | String| The data source to use for underlying stock prices | [optional]   
+ **expiration_start_date** | Date| Filter options by expiration date (start) | [optional]   
+ **expiration_end_date** | Date| Filter options by expiration date (end) | [optional]   
+ **strike** | Float| Filter options by strike price | [optional]   
+ **strike_greater_than** | Float| Filter options by minimum strike price | [optional]   
+ **strike_less_than** | Float| Filter options by maximum strike price | [optional]   
+ **page_size** | Integer| Number of results to return per page | [optional] [default to 250]  
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsGreeksByTickerRealtime**](ApiResponseOptionsGreeksByTickerRealtime.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:options_greeks_contract_realtime_get)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsGreekContractRealtime)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsGreekContractRealtime.md)
+
+[//]: # (OPERATION:options_greeks_contract_realtime_get_v2)
+
+[//]: # (ENDPOINT:/options/greeks/{contract}/realtime)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#options_greeks_contract_realtime_get)
+
+## **options_greeks_contract_realtime_get**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/options_greeks_contract_realtime_get_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsGreekContractRealtime options_greeks_contract_realtime_get(contract, opts)
+
+#### Get realtime options greeks for a specific contract
+
+
+Retrieves realtime options greeks data for a specific options contract
+
+[//]: # (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
+contract = "contract_example"
+
+opts = {
+  source: "source_example",
+  model: "black_scholes",
+  iv_mode: "iv_mode_example",
+  stock_price_source: "stock_price_source_example"
+}
+
+result = options_api.options_greeks_contract_realtime_get(contract, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contract** | String| The options contract identifier |   
+ **source** | String| The data source to use for options data | [optional]   
+ **model** | String| The options pricing model to use for greeks calculations | [optional] [default to black_scholes]  
+ **iv_mode** | String| The implied volatility calculation mode | [optional]   
+ **stock_price_source** | String| The data source to use for underlying stock prices | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsGreekContractRealtime**](ApiResponseOptionsGreekContractRealtime.md)
+
+[//]: # (END_OPERATION)
+