RubyGems - intrinio-sdk - Versions diffs - 5.6.4 → 5.7.0 - Mend

intrinio-sdk 5.6.4 → 5.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (473) hide show

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b33acddfd45f0671968a38b1d4c24c9bcbfd46e74489a01f5559c829e06bdd42
-  data.tar.gz: 3b5871e9ae36696bf7baf66c51f7e8a9e8213abe5fd6042a4be0f57e95250806
+  metadata.gz: f5b012168235646c5a7cf51ee332b2d1efa01c1387cd8ea6c9141cdf4157ba71
+  data.tar.gz: 6b59aa2ec9831eaa4a34fddb83dd7185e4f6843e59057ce13ca7c1d7d4e886c6
 SHA512:
-  metadata.gz: 156ae48c689b6659cf755c5cefc39220a08f3b55770b39529d35b229973d6af4cb75c55aed1ba1c266960f77d735457841102a9dc5558e61af71970a76b7e6ed
-  data.tar.gz: 14c88aa9d2ca2eefd4a71e3b6b1d995621a03ef2376f8b364e737b44b4a0e25faba828c0be92bfd6acda7e0678676c2fc7dac8780d0d29b57625da50c76b86bc
+  metadata.gz: eacb931ab9468252b7122b28bf4310776a8a2c7bd83b2173aff9ffb13ebc6aaa681d43ec6563e9f5049b6d03d07e9ddecee2204d2f71991acbda2857b529906d
+  data.tar.gz: 579a7a5be3a0115a5c066ff7ccfa12bc85cc088e9366c8f68de32cdc17845d98451d5d8a3eb30609f91ff48f1cde5c273d836f367a06337a8ceea071d3e5fad8

data/README.md CHANGED

@@ -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.16.4
-- Package version: 5.6.4
+- API version: 2.17.0
+- Package version: 5.7.0
 ## Installation
@@ -131,6 +131,7 @@ Class | Method | HTTP request | Description
 *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::OptionsApi* | [**get_options_stats_realtime**](docs/OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats 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
@@ -260,11 +261,12 @@ 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::ApiResponseOptionsPriceRealtime](docs/ApiResponseOptionsPriceRealtime.md)
+ - [Intrinio::ApiResponseOptionsStatsRealtime](docs/ApiResponseOptionsStatsRealtime.md)
  - [Intrinio::ApiResponseReportedFinancials](docs/ApiResponseReportedFinancials.md)
  - [Intrinio::ApiResponseSICIndexHistoricalData](docs/ApiResponseSICIndexHistoricalData.md)
  - [Intrinio::ApiResponseSICIndices](docs/ApiResponseSICIndices.md)
@@ -386,9 +388,11 @@ Class | Method | HTTP request | Description
  - [Intrinio::Option](docs/Option.md)
  - [Intrinio::OptionChain](docs/OptionChain.md)
  - [Intrinio::OptionChainRealtime](docs/OptionChainRealtime.md)
+ - [Intrinio::OptionFactorsRealtime](docs/OptionFactorsRealtime.md)
  - [Intrinio::OptionPrice](docs/OptionPrice.md)
  - [Intrinio::OptionPriceRealtime](docs/OptionPriceRealtime.md)
  - [Intrinio::OptionRealtime](docs/OptionRealtime.md)
+ - [Intrinio::OptionStatsRealtime](docs/OptionStatsRealtime.md)
  - [Intrinio::RealtimeStockPrice](docs/RealtimeStockPrice.md)
  - [Intrinio::RealtimeStockPriceSecurity](docs/RealtimeStockPriceSecurity.md)
  - [Intrinio::RelativeStrengthIndexTechnicalValue](docs/RelativeStrengthIndexTechnicalValue.md)

data/docs/ApiResponseOptionsPriceRealtime.md ADDED

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

data/docs/ApiResponseOptionsStatsRealtime.md ADDED

@@ -0,0 +1,31 @@
+[//]: # (CLASS:Intrinio::ApiResponseOptionsStatsRealtime)
+[//]: # (KIND:object)
+### Intrinio::ApiResponseOptionsStatsRealtime
+#### Properties
+[//]: # (START_DEFINITION)
+Name | Type | Description
+------------ | ------------- | -------------
+**stats** | [**OptionStatsRealtime**](OptionStatsRealtime.md) |  &nbsp;
+**factors** | [**OptionFactorsRealtime**](OptionFactorsRealtime.md) |  &nbsp;
+**option** | [**OptionRealtime**](OptionRealtime.md) |  &nbsp;
+[//]: # (END_DEFINITION)
+[//]: # (CONTAINED_CLASS:Intrinio::OptionStatsRealtime)
+[//]: # (CONTAINED_CLASS:Intrinio::OptionFactorsRealtime)
+[//]: # (CONTAINED_CLASS:Intrinio::OptionRealtime)

data/docs/OptionChainRealtime.md CHANGED

@@ -14,6 +14,7 @@ Name | Type | Description
 ------------ | ------------- | -------------
 **option** | [**OptionRealtime**](OptionRealtime.md) |  &nbsp;
 **price** | [**OptionPriceRealtime**](OptionPriceRealtime.md) |  &nbsp;
+**stats** | [**OptionStatsRealtime**](OptionStatsRealtime.md) |  &nbsp;
 [//]: # (END_DEFINITION)
@@ -24,4 +25,7 @@ Name | Type | Description
 [//]: # (CONTAINED_CLASS:Intrinio::OptionPriceRealtime)
+[//]: # (CONTAINED_CLASS:Intrinio::OptionStatsRealtime)

data/docs/OptionFactorsRealtime.md ADDED

@@ -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 &nbsp;
+**underlying_price** | Float | The market price of the underlying asset &nbsp;
+**strike_price** | Float | The strike price of the options contract &nbsp;
+**days_to_expiration** | Float | The number of days to expiration &nbsp;
+**risk_free_interest_rate** | Float | The current risk-free interest rate, as measured by the 3-month Treasury Bill rate &nbsp;
+**dividend_yield** | Float | The divident yield of the underlying asset (if applicable) &nbsp;
+[//]: # (END_DEFINITION)

data/docs/OptionStatsRealtime.md ADDED

@@ -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. &nbsp;
+**delta** | Float | Delta represents the rate of change between the option&#39;s price and a $1 change in the underlying asset&#39;s price. &nbsp;
+**gamma** | Float | Gamma represents the rate of change between an option&#39;s delta and the underlying asset&#39;s price. &nbsp;
+**theta** | Float | Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option&#39;s time decay. &nbsp;
+**vega** | Float | Vega represents the rate of change between an option&#39;s value and the underlying asset&#39;s implied volatility. &nbsp;
+[//]: # (END_DEFINITION)

data/docs/OptionsApi.md CHANGED

@@ -10,6 +10,7 @@ Method | HTTP request | Description
 [**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
@@ -257,7 +258,7 @@ end
 options_api = Intrinio::OptionsApi.new
 symbol = "MSFT"
-expiration = "2021-01-08"
+expiration = "2023-01-20"
 opts = {
   source: nil,
@@ -487,11 +488,11 @@ Name | Type | Description  | Notes
 [//]: # (METHOD:get_options_prices_realtime)
-[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionPricesRealtime)
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsPriceRealtime)
 [//]: # (RETURN_TYPE_KIND:object)
-[//]: # (RETURN_TYPE_DOC:ApiResponseOptionPricesRealtime.md)
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsPriceRealtime.md)
 [//]: # (OPERATION:get_options_prices_realtime_v2)
@@ -505,7 +506,7 @@ Name | Type | Description  | Notes
 [//]: # (START_OVERVIEW)
-> ApiResponseOptionPricesRealtime get_options_prices_realtime(identifier, opts)
+> ApiResponseOptionsPriceRealtime get_options_prices_realtime(identifier, opts)
 #### Option Prices Realtime
@@ -558,7 +559,89 @@ Name | Type | Description  | Notes
 ### Return type
-[**ApiResponseOptionPricesRealtime**](ApiResponseOptionPricesRealtime.md)
+[**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. |  &nbsp;
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]  &nbsp;
+[//]: # (END_PARAMETERS)
+### Return type
+[**ApiResponseOptionsStatsRealtime**](ApiResponseOptionsStatsRealtime.md)
 [//]: # (END_OPERATION)

data/docs/SecurityApi.md CHANGED

@@ -123,6 +123,7 @@ opts = {
   figi_unique_id: nil,
   include_non_figi: false,
   page_size: 100,
+  primary_listing: nil,
   next_page: nil
 }
@@ -158,6 +159,7 @@ Name | Type | Description  | Notes
  **figi_unique_id** | String| Return securities with the given FIGI Unique ID (&lt;a href&#x3D;\&quot;https://www.openfigi.com/about\&quot; target&#x3D;\&quot;_blank\&quot;&gt;reference&lt;/a&gt;). | [optional]  &nbsp;
  **include_non_figi** | BOOLEAN| When true, include securities that do not have a FIGI. By default, this is false. If this parameter is not specified, only securities with a FIGI are returned. | [optional] [default to false] &nbsp;
  **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp;
+ **primary_listing** | BOOLEAN| If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange | [optional]  &nbsp;
  **next_page** | String| Gets the next page of data from a previous API call | [optional]  &nbsp;
 [//]: # (END_PARAMETERS)
@@ -3638,7 +3640,7 @@ security_api = Intrinio::SecurityApi.new
 identifier = "AAPL"
 opts = {
-  source: nil
+  source: "bats"
 }
 result = security_api.get_security_realtime_price(identifier, opts)

data/docs/SecuritySummary.md CHANGED

@@ -22,6 +22,7 @@ Name | Type | Description
 **figi** | String | The OpenFIGI identifier &nbsp;
 **composite_figi** | String | The country-composite OpenFIGI identifier &nbsp;
 **share_class_figi** | String | The global-composite OpenFIGI identifier &nbsp;
+**primary_listing** | BOOLEAN | If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange &nbsp;
 [//]: # (END_DEFINITION)

data/intrinio-sdk.gemspec CHANGED

@@ -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.16.4
+OpenAPI spec version: 2.17.0
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk.rb CHANGED

@@ -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.16.4
+OpenAPI spec version: 2.17.0
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -46,11 +46,12 @@ 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_options_price_realtime'
+require 'intrinio-sdk/models/api_response_options_stats_realtime'
 require 'intrinio-sdk/models/api_response_reported_financials'
 require 'intrinio-sdk/models/api_response_sic_index_historical_data'
 require 'intrinio-sdk/models/api_response_sic_indices'
@@ -172,9 +173,11 @@ 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_factors_realtime'
 require 'intrinio-sdk/models/option_price'
 require 'intrinio-sdk/models/option_price_realtime'
 require 'intrinio-sdk/models/option_realtime'
+require 'intrinio-sdk/models/option_stats_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'

data/lib/intrinio-sdk/api/bulk_downloads_api.rb CHANGED

@@ -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.16.4
+OpenAPI spec version: 2.17.0
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/company_api.rb CHANGED

@@ -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.16.4
+OpenAPI spec version: 2.17.0
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/data_point_api.rb CHANGED

@@ -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.16.4
+OpenAPI spec version: 2.17.0
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/data_tag_api.rb CHANGED

@@ -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.16.4
+OpenAPI spec version: 2.17.0
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/et_fs_api.rb CHANGED

@@ -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.16.4
+OpenAPI spec version: 2.17.0
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/filing_api.rb CHANGED

@@ -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.16.4
+OpenAPI spec version: 2.17.0
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset