intrinio-sdk 5.6.3 → 5.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10612aec4776709f86ebcae1583e3a8f2df2f280d1a54e665fb7df8859f22ab2
-  data.tar.gz: c56bf2901e062e6da0c9ba5e6db88d7eb25d8cdad83a1d05056ec38abf2d6c26
+  metadata.gz: b33acddfd45f0671968a38b1d4c24c9bcbfd46e74489a01f5559c829e06bdd42
+  data.tar.gz: 3b5871e9ae36696bf7baf66c51f7e8a9e8213abe5fd6042a4be0f57e95250806
 SHA512:
-  metadata.gz: 8713e1633401fc33567baab298148c2175d182f972599aa6a295eabe233f2ee75b5d24fc848ae4b8f77d9d27d07a11bff44acbae48d7976da1abe351f5820479
-  data.tar.gz: 98de49c33fe99ac075dfaf722a3cc81c83cea548c31b237dda0ccd9e228dfdfa4e34a5c0db8f64d702f801cb8c2f105f5dd33a67df2d17d2a0f0304136f32772
+  metadata.gz: 156ae48c689b6659cf755c5cefc39220a08f3b55770b39529d35b229973d6af4cb75c55aed1ba1c266960f77d735457841102a9dc5558e61af71970a76b7e6ed
+  data.tar.gz: 14c88aa9d2ca2eefd4a71e3b6b1d995621a03ef2376f8b364e737b44b4a0e25faba828c0be92bfd6acda7e0678676c2fc7dac8780d0d29b57625da50c76b86bc

data/README.md

@@ -8,8 +8,8 @@ Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 2.15.3
-- Package version: 5.6.3
+- API version: 2.16.4
+- Package version: 5.6.4
 
 
 ## Installation
@@ -127,8 +127,10 @@ Class | Method | HTTP request | Description
 *Intrinio::MunicipalityApi* | [**get_municipality_financials**](docs/MunicipalityApi.md#get_municipality_financials) | **GET** /municipalities/{id}/financials | Financials for a Municipality
 *Intrinio::OptionsApi* | [**get_options**](docs/OptionsApi.md#get_options) | **GET** /options/{symbol} | Options
 *Intrinio::OptionsApi* | [**get_options_chain**](docs/OptionsApi.md#get_options_chain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain
+*Intrinio::OptionsApi* | [**get_options_chain_realtime**](docs/OptionsApi.md#get_options_chain_realtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
 *Intrinio::OptionsApi* | [**get_options_expirations**](docs/OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
 *Intrinio::OptionsApi* | [**get_options_prices**](docs/OptionsApi.md#get_options_prices) | **GET** /options/prices/{identifier} | Option Prices
+*Intrinio::OptionsApi* | [**get_options_prices_realtime**](docs/OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
 *Intrinio::SecurityApi* | [**get_all_securities**](docs/SecurityApi.md#get_all_securities) | **GET** /securities | All Securities
 *Intrinio::SecurityApi* | [**get_security_by_id**](docs/SecurityApi.md#get_security_by_id) | **GET** /securities/{identifier} | Lookup Security
 *Intrinio::SecurityApi* | [**get_security_data_point_number**](docs/SecurityApi.md#get_security_data_point_number) | **GET** /securities/{identifier}/data_point/{tag}/number | Data Point (Number) for Security
@@ -258,8 +260,10 @@ Class | Method | HTTP request | Description
  - [Intrinio::ApiResponseMunicipalitiyFinancials](docs/ApiResponseMunicipalitiyFinancials.md)
  - [Intrinio::ApiResponseNews](docs/ApiResponseNews.md)
  - [Intrinio::ApiResponseOptionPrices](docs/ApiResponseOptionPrices.md)
+ - [Intrinio::ApiResponseOptionPricesRealtime](docs/ApiResponseOptionPricesRealtime.md)
  - [Intrinio::ApiResponseOptions](docs/ApiResponseOptions.md)
  - [Intrinio::ApiResponseOptionsChain](docs/ApiResponseOptionsChain.md)
+ - [Intrinio::ApiResponseOptionsChainRealtime](docs/ApiResponseOptionsChainRealtime.md)
  - [Intrinio::ApiResponseOptionsExpirations](docs/ApiResponseOptionsExpirations.md)
  - [Intrinio::ApiResponseReportedFinancials](docs/ApiResponseReportedFinancials.md)
  - [Intrinio::ApiResponseSICIndexHistoricalData](docs/ApiResponseSICIndexHistoricalData.md)
@@ -381,7 +385,10 @@ Class | Method | HTTP request | Description
  - [Intrinio::OnBalanceVolumeTechnicalValue](docs/OnBalanceVolumeTechnicalValue.md)
  - [Intrinio::Option](docs/Option.md)
  - [Intrinio::OptionChain](docs/OptionChain.md)
+ - [Intrinio::OptionChainRealtime](docs/OptionChainRealtime.md)
  - [Intrinio::OptionPrice](docs/OptionPrice.md)
+ - [Intrinio::OptionPriceRealtime](docs/OptionPriceRealtime.md)
+ - [Intrinio::OptionRealtime](docs/OptionRealtime.md)
  - [Intrinio::RealtimeStockPrice](docs/RealtimeStockPrice.md)
  - [Intrinio::RealtimeStockPriceSecurity](docs/RealtimeStockPriceSecurity.md)
  - [Intrinio::RelativeStrengthIndexTechnicalValue](docs/RelativeStrengthIndexTechnicalValue.md)

data/docs/ApiResponseOptionPricesRealtime.md

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

data/docs/ApiResponseOptionsChainRealtime.md

@@ -0,0 +1,23 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseOptionsChainRealtime)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseOptionsChainRealtime
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**chain** | [**Array<OptionChainRealtime>**](OptionChainRealtime.md) | A list of realtime options for the provided expiration date their respective option prices.  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionChainRealtime)
+
+
+

data/docs/CompanyApi.md

@@ -1116,6 +1116,7 @@ company_api = Intrinio::CompanyApi.new
 query = "Apple"
 
 opts = {
+  active: true,
   page_size: 100
 }
 
@@ -1135,6 +1136,7 @@ pp result
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **query** | String| Search parameters |   
+ **active** | BOOLEAN| When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded. | [optional]   
  **page_size** | Integer| The number of results to return | [optional] [default to 100]  
 
 [//]: # (END_PARAMETERS)

data/docs/OptionChainRealtime.md

@@ -0,0 +1,27 @@
+
+
+[//]: # (CLASS:Intrinio::OptionChainRealtime)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionChainRealtime
+
+#### 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/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/OptionsApi.md

@@ -6,8 +6,10 @@ 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
 
 
 
@@ -205,6 +207,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 = "2021-01-08"
+
+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 +480,85 @@ Name | Type | Description  | Notes
 
 [//]: # (END_OPERATION)
 
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_options_prices_realtime)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionPricesRealtime)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionPricesRealtime.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)
+
+> ApiResponseOptionPricesRealtime 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
+
+[**ApiResponseOptionPricesRealtime**](ApiResponseOptionPricesRealtime.md)
+
+[//]: # (END_OPERATION)
+

data/docs/SecurityApi.md

@@ -4239,7 +4239,7 @@ Name | Type | Description  | Notes
 #### Screen Securities
 
 
-Screen Securities using complex logic
+Screen Securities using complex logic. Use POST only. See <a href=\"https://docs.intrinio.com/documentation/screener_v2\" target=\"_blank\">screener documentation</a> for details on how to construct conditions.
 
 [//]: # (END_OVERVIEW)
 
@@ -4296,7 +4296,7 @@ pp result
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **logic** | [**SecurityScreenGroup**](SecurityScreenGroup.md)| The logic to screen with, consisting of operators, clauses, and nested groups.&lt;br/&gt; See &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions. | [optional]  &nbsp;
+ **logic** | [**SecurityScreenGroup**](SecurityScreenGroup.md)| The logic to screen with, consisting of operators, clauses, and nested groups. &lt;/br&gt; See &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions. | [optional]  &nbsp;
  **order_column** | String| Results returned sorted by this column | [optional]  &nbsp;
  **order_direction** | String| Sort order to use with the order_column | [optional] [default to asc] &nbsp;
  **primary_only** | BOOLEAN| Return only primary securities | [optional] [default to false] &nbsp;

data/intrinio-sdk.gemspec

@@ -5,7 +5,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk.rb

@@ -3,7 +3,7 @@
 
 #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-OpenAPI spec version: 2.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -46,8 +46,10 @@ require 'intrinio-sdk/models/api_response_municipalities'
 require 'intrinio-sdk/models/api_response_municipalitiy_financials'
 require 'intrinio-sdk/models/api_response_news'
 require 'intrinio-sdk/models/api_response_option_prices'
+require 'intrinio-sdk/models/api_response_option_prices_realtime'
 require 'intrinio-sdk/models/api_response_options'
 require 'intrinio-sdk/models/api_response_options_chain'
+require 'intrinio-sdk/models/api_response_options_chain_realtime'
 require 'intrinio-sdk/models/api_response_options_expirations'
 require 'intrinio-sdk/models/api_response_reported_financials'
 require 'intrinio-sdk/models/api_response_sic_index_historical_data'
@@ -169,7 +171,10 @@ require 'intrinio-sdk/models/on_balance_volume_mean_technical_value'
 require 'intrinio-sdk/models/on_balance_volume_technical_value'
 require 'intrinio-sdk/models/option'
 require 'intrinio-sdk/models/option_chain'
+require 'intrinio-sdk/models/option_chain_realtime'
 require 'intrinio-sdk/models/option_price'
+require 'intrinio-sdk/models/option_price_realtime'
+require 'intrinio-sdk/models/option_realtime'
 require 'intrinio-sdk/models/realtime_stock_price'
 require 'intrinio-sdk/models/realtime_stock_price_security'
 require 'intrinio-sdk/models/relative_strength_index_technical_value'