intrinio-sdk 5.8.0 → 5.12.0

data/docs/InstitutionalHolding.md

@@ -0,0 +1,34 @@
+
+
+[//]: # (CLASS:Intrinio::InstitutionalHolding)
+
+[//]: # (KIND:object)
+
+### Intrinio::InstitutionalHolding
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**cusip** | String | The CUSIP number for the security report by the Institutional Owner  
+**ticker** | String | The ticker symbol for the security  
+**security_name** | String | The name of the security  
+**security_type** | String | The type of the security  
+**title_of_class** | String | The class of stock held  
+**stock_exchange** | String | The stock exchange where the security is traded  
+**filing_date** | Date | The date when the filing was submitted to the SEC by the company  
+**value** | Float | The market value in amount of dollars of the holding in the listed security  
+**amount** | Float | The number of shares held in the listed security  
+**type** | String | Shares  
+**investment_discretion** | String | Segregate the holdings of securities of a class according to the nature of the investment discretion held by the Manager.  
+**other_manager** | String | A code for other managerial authority of the securities listed  
+**sole_voting_authority** | Float | The number of shares where the insitutional holder has sole voting authority  
+**shared_voting_authority** | Float | The number of shares where the insitutional holder has shared voting authority  
+**no_voting_authority** | Float | The number of shares where the insitutional holder has no voting authority  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/InstitutionalOwnership.md

@@ -0,0 +1,29 @@
+
+
+[//]: # (CLASS:Intrinio::InstitutionalOwnership)
+
+[//]: # (KIND:object)
+
+### Intrinio::InstitutionalOwnership
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**owner_cik** | String | The Central Index Key issued by the SEC, which is the unique identifier all owner filings  
+**owner_name** | String | The name of the institutional owner  
+**value** | Float | The market value in amount of dollars of the holding in the listed security  
+**amount** | Float | The number of shares held in the listed security  
+**sole_voting_authority** | Float | The number of shares where the insitutional holder has sole voting authority  
+**shared_voting_authority** | Float | The number of shares where the insitutional holder has shared voting authority  
+**no_voting_authority** | Float | The number of shares where the insitutional holder has no voting authority  
+**previous_amount** | Float | The prior quarter number of shares held by the owner  
+**amount_change** | Float | The change in number of shares held from the prior quarter  
+**amount_percent_change** | Float | The percentage change in the number of shares held from the prior quarter  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OptionContractsList.md

@@ -0,0 +1,20 @@
+
+
+[//]: # (CLASS:Intrinio::OptionContractsList)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionContractsList
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**contracts** | Array<String> |   
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OptionPriceBatchRealtime.md

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

data/docs/OptionsApi.md

@@ -4,16 +4,178 @@ 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_expirations_realtime**](OptionsApi.md#get_option_expirations_realtime) | **GET** /options/expirations/{symbol}/realtime | Option Expirations Realtime
 [**get_options**](OptionsApi.md#get_options) | **GET** /options/{symbol} | Options
+[**get_options_by_symbol_realtime**](OptionsApi.md#get_options_by_symbol_realtime) | **GET** /options/{symbol}/realtime | Options by Symbol Realtime
 [**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_batch_realtime**](OptionsApi.md#get_options_prices_batch_realtime) | **POST** /options/prices/realtime/batch | Option Prices Batch Realtime
 [**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
 
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_all_options_tickers)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsTickers)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsTickers.md)
+
+[//]: # (OPERATION:get_all_options_tickers_v2)
+
+[//]: # (ENDPOINT:/options/tickers)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_all_options_tickers)
+
+## **get_all_options_tickers**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_options_tickers_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsTickers get_all_options_tickers
+
+#### Options Tickers
+
+
+Returns all tickers that have existing options contracts.
+
+[//]: # (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
+result = options_api.get_all_options_tickers
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+This endpoint does not need any parameter.
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsTickers**](ApiResponseOptionsTickers.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_option_expirations_realtime)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsExpirations)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsExpirations.md)
+
+[//]: # (OPERATION:get_option_expirations_realtime_v2)
+
+[//]: # (ENDPOINT:/options/expirations/{symbol}/realtime)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_option_expirations_realtime)
+
+## **get_option_expirations_realtime**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_option_expirations_realtime_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsExpirations get_option_expirations_realtime(symbol, opts)
+
+#### Option Expirations Realtime
+
+
+Returns all realtime option contract expiration dates for a given 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 = "MSFT"
+
+opts = {
+  after: "2022-01-01",
+  before: "2023-04-01",
+  source: nil
+}
+
+result = options_api.get_option_expirations_realtime(symbol, 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. |   
+ **after** | String| Return option contract expiration dates after this date. | [optional]   
+ **before** | String| Return option contract expiration dates before this date. | [optional]   
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsExpirations**](ApiResponseOptionsExpirations.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::OptionsApi)
@@ -112,6 +274,102 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_options_by_symbol_realtime)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsRealtime)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsRealtime.md)
+
+[//]: # (OPERATION:get_options_by_symbol_realtime_v2)
+
+[//]: # (ENDPOINT:/options/{symbol}/realtime)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_by_symbol_realtime)
+
+## **get_options_by_symbol_realtime**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_options_by_symbol_realtime_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsRealtime get_options_by_symbol_realtime(symbol, opts)
+
+#### Options by Symbol Realtime
+
+
+Returns the master list of realtime option contracts for a given 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 = "AAPL"
+
+opts = {
+  type: "put",
+  strike: 170,
+  strike_greater_than: 150,
+  strike_less_than: 190,
+  expiration: "2022-04-16",
+  expiration_after: "2022-01-01",
+  expiration_before: "2023-12-31",
+  source: nil
+}
+
+result = options_api.get_options_by_symbol_realtime(symbol, 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. |   
+ **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]   
+ **expiration** | String| The expiration date of the option contract. This will return options contracts with expiration dates on this date. | [optional]   
+ **expiration_after** | String| The expiration date of the option contract. This will return options contracts with expiration dates after this date. | [optional]   
+ **expiration_before** | String| The expiration date of the option contract. This will return options contracts with expiration dates before this date. | [optional]   
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsRealtime**](ApiResponseOptionsRealtime.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::OptionsApi)
@@ -482,6 +740,94 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_options_prices_batch_realtime)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsPricesBatchRealtime)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsPricesBatchRealtime.md)
+
+[//]: # (OPERATION:get_options_prices_batch_realtime_v2)
+
+[//]: # (ENDPOINT:/options/prices/realtime/batch)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_prices_batch_realtime)
+
+## **get_options_prices_batch_realtime**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_options_prices_batch_realtime_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsPricesBatchRealtime get_options_prices_batch_realtime(body, opts)
+
+#### Option Prices Batch Realtime
+
+
+Returns options prices for a supplied list of option symbols.
+
+[//]: # (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
+body = {
+  contracts: [
+    "A220121P00055000",
+    "A220121P00057500",
+    "A220121P00060000"
+  ]
+}
+
+opts = {
+  source: nil
+}
+
+result = options_api.get_options_prices_batch_realtime(body, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**OptionContractsList**](OptionContractsList.md)| The contract symbols for which to return options prices for. |   
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsPricesBatchRealtime**](ApiResponseOptionsPricesBatchRealtime.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::OptionsApi)