intrinio-sdk 5.6.1 → 5.9.0

data/docs/OptionStatsRealtime.md

@@ -0,0 +1,24 @@
+
+
+[//]: # (CLASS:Intrinio::OptionStatsRealtime)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionStatsRealtime
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**implied_volatility** | Float | The implied volatility of the contract calculated using the Black-Scholes Model.  
+**delta** | Float | Delta represents the rate of change between the option's price and a $1 change in the underlying asset's price.  
+**gamma** | Float | Gamma represents the rate of change between an option's delta and the underlying asset's price.  
+**theta** | Float | Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.  
+**vega** | Float | Vega represents the rate of change between an option's value and the underlying asset's implied volatility.  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OptionsApi.md

@@ -6,8 +6,11 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_options**](OptionsApi.md#get_options) | **GET** /options/{symbol} | Options
 [**get_options_chain**](OptionsApi.md#get_options_chain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain
+[**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_prices**](OptionsApi.md#get_options_prices) | **GET** /options/prices/{identifier} | Option Prices
+[**get_options_prices_realtime**](OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
+[**get_options_stats_realtime**](OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
 
 
 
@@ -56,30 +59,26 @@ 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 = "MSFT" # String | The option symbol, corresponding to the underlying security.
-
-opts = { 
-  type: "put", # String | The option contract type.
-  strike: 170.0, # Float | The strike price of the option contract. This will return options contracts with strike price equal to this price.
-  strike_greater_than: 190.0, # Float | The strike price of the option contract. This will return options contracts with strike prices greater than this price.
-  strike_less_than: 150.0, # Float | The strike price of the option contract. This will return options contracts with strike prices less than this price.
-  expiration: "2019-03-01", # String | The expiration date of the option contract. This will return options contracts with expiration dates on this date.
-  expiration_after: "2019-01-01", # String | The expiration date of the option contract. This will return options contracts with expiration dates after this date.
-  expiration_before: "2019-12-31", # String | The expiration date of the option contract. This will return options contracts with expiration dates before this date.
-  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
+symbol = "AAPL"
+
+opts = {
+  type: "put",
+  strike: 170,
+  strike_greater_than: 150,
+  strike_less_than: 190,
+  expiration: "2019-03-01",
+  expiration_after: "2019-01-01",
+  expiration_before: "2019-12-31",
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = options_api.get_options(symbol, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling OptionsApi->get_options: #{e}"
-end
+result = options_api.get_options(symbol, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -158,30 +157,25 @@ 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 = "MSFT" # String | The option symbol, corresponding to the underlying security.
-
-expiration = "2019-04-05" # String | The expiration date of the options contract
-
-opts = { 
-  date: Date.parse("2019-04-05"), # Date | The date of the option price. Returns option prices on this date.
-  type: "put", # String | The option contract type.
-  strike: 170.0, # Float | The strike price of the option contract. This will return options contracts with strike price equal to this price.
-  strike_greater_than: 190.0, # Float | The strike price of the option contract. This will return options contracts with strike prices greater than this price.
-  strike_less_than: 150.0, # Float | The strike price of the option contract. This will return options contracts with strike prices less than this price.
-  moneyness: "in_the_money", # String | The moneyness of the options contracts to return. 'all' will return all options contracts. 'in_the_money' will return options contracts that are in the money (call options with strike prices below the current price, put options with strike prices above the current price). 'out_of_they_money' will return options contracts that are out of the money (call options with strike prices above the current price, put options with strike prices below the current price). 'near_the_money' will return options contracts that are $0.50 or less away from being in the money.
-  page_size: 100 # Integer | The number of results to return
+symbol = "MSFT"
+expiration = "2019-04-05"
+
+opts = {
+  date: nil,
+  type: nil,
+  strike: nil,
+  strike_greater_than: nil,
+  strike_less_than: nil,
+  moneyness: nil,
+  page_size: 100
 }
 
-begin
-  result = options_api.get_options_chain(symbol, expiration, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling OptionsApi->get_options_chain: #{e}"
-end
+result = options_api.get_options_chain(symbol, expiration, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -214,6 +208,108 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_options_chain_realtime)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsChainRealtime)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsChainRealtime.md)
+
+[//]: # (OPERATION:get_options_chain_realtime_v2)
+
+[//]: # (ENDPOINT:/options/chain/{symbol}/{expiration}/realtime)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_chain_realtime)
+
+## **get_options_chain_realtime**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_options_chain_realtime_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsChainRealtime get_options_chain_realtime(symbol, expiration, opts)
+
+#### Options Chain Realtime
+
+
+Returns all realtime options contracts and their prices for the given symbol and expiration date.
+
+[//]: # (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 = "MSFT"
+expiration = "2023-01-20"
+
+opts = {
+  source: nil,
+  type: nil,
+  strike: nil,
+  strike_greater_than: nil,
+  strike_less_than: nil,
+  volume_greater_than: nil,
+  volume_less_than: nil,
+  open_interest_greater_than: nil,
+  open_interest_less_than: nil,
+  moneyness: nil
+}
+
+result = options_api.get_options_chain_realtime(symbol, expiration, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **symbol** | String| The option symbol, corresponding to the underlying security. |   
+ **expiration** | String| The expiration date of the options contract |   
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]   
+ **type** | String| The option contract type. | [optional]   
+ **strike** | Float| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]   
+ **strike_greater_than** | Float| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]   
+ **strike_less_than** | Float| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]   
+ **volume_greater_than** | Float| The volume of the option contract. This will return options contracts with volumes greater than this amount. | [optional]   
+ **volume_less_than** | Float| The volume of the option contract. This will return options contracts with volumes less than this amout. | [optional]   
+ **open_interest_greater_than** | Float| The open interest of the option contract. This will return options contracts with open interest greater than this amount. | [optional]   
+ **open_interest_less_than** | Float| The open interest of the option contract. This will return options contracts with open interest less than this amount. | [optional]   
+ **moneyness** | String| The moneyness of the options contracts to return. 'all' will return all options contracts. 'in_the_money' will return options contracts that are in the money (call options with strike prices below the current price, put options with strike prices above the current price). 'out_of_they_money' will return options contracts that are out of the money (call options with strike prices above the current price, put options with strike prices below the current price). 'near_the_money' will return options contracts that are $0.50 or less away from being in the money.  Requires subscription to realtime stock price data. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsChainRealtime**](ApiResponseOptionsChainRealtime.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::OptionsApi)
@@ -259,23 +355,19 @@ 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 = "MSFT"
 
-symbol = "MSFT" # String | The option symbol, corresponding to the underlying security.
-
-opts = { 
-  after: "2019-01-01", # String | Return option contract expiration dates after this date.
-  before: "2019-12-31" # String | Return option contract expiration dates before this date.
+opts = {
+  after: "2019-01-01",
+  before: "2019-12-31"
 }
 
-begin
-  result = options_api.get_options_expirations(symbol, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling OptionsApi->get_options_expirations: #{e}"
-end
+result = options_api.get_options_expirations(symbol, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -347,25 +439,21 @@ 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 = "MSFT190405C00118000"
 
-identifier = "identifier_example" # String | The Intrinio ID or code of the options contract to request prices for.
-
-opts = { 
-  start_date: "2019-01-01", # String | Return option contract prices on or after this date.
-  end_date: "2019-12-31", # String | Return option contract prices on or before this date.
-  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 = {
+  start_date: "2019-01-01",
+  end_date: "2019-12-31",
+  page_size: 100,
+  next_page: nil
 }
 
-begin
-  result = options_api.get_options_prices(identifier, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling OptionsApi->get_options_prices: #{e}"
-end
+result = options_api.get_options_prices(identifier, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -393,3 +481,167 @@ Name | Type | Description  | Notes
 
 [//]: # (END_OPERATION)
 
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_options_prices_realtime)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsPriceRealtime)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsPriceRealtime.md)
+
+[//]: # (OPERATION:get_options_prices_realtime_v2)
+
+[//]: # (ENDPOINT:/options/prices/{identifier}/realtime)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_prices_realtime)
+
+## **get_options_prices_realtime**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_options_prices_realtime_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsPriceRealtime get_options_prices_realtime(identifier, opts)
+
+#### Option Prices Realtime
+
+
+Returns all option prices for a given option contract 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
+
+options_api = Intrinio::OptionsApi.new
+identifier = "AAPL230120C00090000"
+
+opts = {
+  source: nil
+}
+
+result = options_api.get_options_prices_realtime(identifier, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| The Intrinio ID or code of the options contract to request prices for. |   
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsPriceRealtime**](ApiResponseOptionsPriceRealtime.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_options_stats_realtime)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsStatsRealtime)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsStatsRealtime.md)
+
+[//]: # (OPERATION:get_options_stats_realtime_v2)
+
+[//]: # (ENDPOINT:/options/prices/{identifier}/realtime/stats)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_stats_realtime)
+
+## **get_options_stats_realtime**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_options_stats_realtime_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsStatsRealtime get_options_stats_realtime(identifier, opts)
+
+#### Option Stats Realtime
+
+
+Returns all option stats (greeks and implied volatility) and factors used to calculate them, for a given option contract 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
+
+options_api = Intrinio::OptionsApi.new
+identifier = "AAPL230120C00090000"
+
+opts = {
+  source: nil
+}
+
+result = options_api.get_options_stats_realtime(identifier, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| The Intrinio ID or code of the options contract to request prices for. |   
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsStatsRealtime**](ApiResponseOptionsStatsRealtime.md)
+
+[//]: # (END_OPERATION)
+