intrinio-sdk 5.6.3 → 5.9.1

data/docs/OptionChainRealtime.md

@@ -0,0 +1,31 @@
+
+
+[//]: # (CLASS:Intrinio::OptionChainRealtime)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionChainRealtime
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**option** | [**OptionRealtime**](OptionRealtime.md) |   
+**price** | [**OptionPriceRealtime**](OptionPriceRealtime.md) |   
+**stats** | [**OptionStatsRealtime**](OptionStatsRealtime.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionRealtime)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionPriceRealtime)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionStatsRealtime)
+
+
+

data/docs/OptionFactorsRealtime.md

@@ -0,0 +1,25 @@
+
+
+[//]: # (CLASS:Intrinio::OptionFactorsRealtime)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionFactorsRealtime
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**market_price** | Float | The market price of the options contract  
+**underlying_price** | Float | The market price of the underlying asset  
+**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)  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OptionPriceRealtime.md

@@ -0,0 +1,31 @@
+
+
+[//]: # (CLASS:Intrinio::OptionPriceRealtime)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionPriceRealtime
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**last** | Float | The price of the last trade  
+**last_size** | Integer | The size of the last trade  
+**last_timestamp** | DateTime | The time of the last trade  
+**volume** | Integer | The cumulative volume of this options contract that traded that day.  
+**ask** | Float | The price of the top ask order  
+**ask_size** | Integer | The size of the top ask order  
+**ask_timestamp** | DateTime | The timestamp of the top ask order  
+**bid** | Float | The price of the top bid order  
+**bid_size** | Integer | The size of the top bid order  
+**bid_timestamp** | DateTime | The time of the top bid order  
+**open_interest** | Integer | The total number of this options contract that are still open.  
+**exercise_style** | String | The exercise style of the option.  (\"A\" = \"American\", \"E\" = \"European\")  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OptionRealtime.md

@@ -0,0 +1,24 @@
+
+
+[//]: # (CLASS:Intrinio::OptionRealtime)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionRealtime
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**code** | String | The Intrinio Code for the Option.  
+**ticker** | String | The ticker symbol of the Security for the Option.  
+**expiration** | Date | The date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.  
+**strike** | Float | The strike price is the fixed price at which a derivative can be exercised, and refers to the price of the derivative’s underlying asset.  In a call option, the strike price is the price at which the option holder can purchase the underlying security.  For a put option, the strike price is the price at which the option holder can sell the underlying security.  
+**type** | String | The type of Option (put or call).  
+
+[//]: # (END_DEFINITION)
+
+
+

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
 
 
 
@@ -205,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)
@@ -376,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)
+

data/docs/Owner.md

@@ -0,0 +1,32 @@
+
+
+[//]: # (CLASS:Intrinio::Owner)
+
+[//]: # (KIND:object)
+
+### Intrinio::Owner
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**id** | String | The Intrinio ID for the Owner  
+**company_id** | String | The Intrinio ID for the company for which the Security is issued  
+**owner_cik** | String | The Central Index Key issued by the SEC, which is the unique identifier all owner filings  
+**name** | String | The name of the owner  
+**state** | String | The state in which the owner is located  
+**state_inc** | String | The state in which the owner is incorporated  
+**country_inc** | String | The country in which the owner is incorporated  
+**business_address** | String | The owner's business address  
+**business_phone_no** | String | The owner's business phone number  
+**mailing_address** | String | The owner's mailing address  
+**institutional** | BOOLEAN | A boolean to include only insider owners who have filed forms 3, 4, or 5 with the SEC  
+**updated_on** | DateTime | The date and time when the data was last updated.  
+**created_on** | DateTime | The date and time when the data was created  
+
+[//]: # (END_DEFINITION)
+
+
+