intrinio-sdk 6.22.2 → 6.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0cfc13729e2c19d340c68a482defdb166db84eabd6732c3fa07124e37e2948f
-  data.tar.gz: 0f2cf9c566f83504da1677d31eaf7984b67064f3a61b24551b540e3118e757a3
+  metadata.gz: a9747921ee64eb699a8d118db672b7a3bb292020f10b1a3b1ebc2fe29243ddf0
+  data.tar.gz: e8858eef44e1a888c18f5c2a7411831d48b415d41f91da2efab78df0c9c58237
 SHA512:
-  metadata.gz: 133230824b4faa020c1eb34012af06237bd440b79afbedf31847f014608dbd16d6737d017543108ca21d3aa39603c99e2676110fd92471cae633ff915b610ee6
-  data.tar.gz: 51140898e8735cdbde6941ea3d5fbd8d09ce3861400d4bab1fadfb3bcde23a33923705604daba2186e5ef639ff657b0bdbb9132ac3650b972af7a71edfaae9d4
+  metadata.gz: 59a15dfeefa622f3a29769e3768e7a31671f56f7931dd55ea36a1e4d22749910226feccd6bdcaf21f7a3ced8a11ad2d9d71d4e816afe54dcbb393f46509e7716
+  data.tar.gz: b6e0c123c257a8d59f5b1354559ca23715836ad3da4164e85300ba7fff95fe36f3b6f7af7c2cf423b9c92d44c6d29fe88272ff8d81a1c552d38ec689ec70165b

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.30.0
-- Package version: 6.22.2
+- API version: 2.39.0
+- Package version: 6.23.0
 
 
 ## Installation
@@ -148,6 +148,10 @@ Class | Method | HTTP request | Description
 *Intrinio::OptionsApi* | [**get_options_chain_eod**](docs/OptionsApi.md#get_options_chain_eod) | **GET** /options/chain/{symbol}/{expiration}/eod | Options Chain EOD
 *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_interval_by_contract**](docs/OptionsApi.md#get_options_interval_by_contract) | **GET** /options/interval/{identifier} | Options Intervals By Contract
+*Intrinio::OptionsApi* | [**get_options_interval_movers**](docs/OptionsApi.md#get_options_interval_movers) | **GET** /options/interval/movers | Options Intervals Movers
+*Intrinio::OptionsApi* | [**get_options_interval_movers_change**](docs/OptionsApi.md#get_options_interval_movers_change) | **GET** /options/interval/movers/change | Options Intervals Movers By Change
+*Intrinio::OptionsApi* | [**get_options_interval_movers_volume**](docs/OptionsApi.md#get_options_interval_movers_volume) | **GET** /options/interval/movers/volume | Options Intervals Movers By Volume
 *Intrinio::OptionsApi* | [**get_options_prices**](docs/OptionsApi.md#get_options_prices) | **GET** /options/prices/{identifier} | Option Prices
 *Intrinio::OptionsApi* | [**get_options_prices_batch_realtime**](docs/OptionsApi.md#get_options_prices_batch_realtime) | **POST** /options/prices/realtime/batch | Option Prices Batch Realtime
 *Intrinio::OptionsApi* | [**get_options_prices_eod**](docs/OptionsApi.md#get_options_prices_eod) | **GET** /options/prices/{identifier}/eod | Option Prices EOD
@@ -169,6 +173,9 @@ Class | Method | HTTP request | Description
 *Intrinio::SecurityApi* | [**get_security_data_point_text**](docs/SecurityApi.md#get_security_data_point_text) | **GET** /securities/{identifier}/data_point/{tag}/text | Data Point (Text) for Security
 *Intrinio::SecurityApi* | [**get_security_historical_data**](docs/SecurityApi.md#get_security_historical_data) | **GET** /securities/{identifier}/historical_data/{tag} | Historical Data for Security
 *Intrinio::SecurityApi* | [**get_security_insider_ownership**](docs/SecurityApi.md#get_security_insider_ownership) | **GET** /securities/{identifier}/institutional_ownership | Institutional Ownership by Security
+*Intrinio::SecurityApi* | [**get_security_interval_movers**](docs/SecurityApi.md#get_security_interval_movers) | **GET** /securities/market_movers | Security Intervals Movers
+*Intrinio::SecurityApi* | [**get_security_interval_movers_change**](docs/SecurityApi.md#get_security_interval_movers_change) | **GET** /securities/market_movers/change | Security Intervals Movers By Change
+*Intrinio::SecurityApi* | [**get_security_interval_movers_volume**](docs/SecurityApi.md#get_security_interval_movers_volume) | **GET** /securities/market_movers/volume | Security Intervals Movers By Volume
 *Intrinio::SecurityApi* | [**get_security_interval_prices**](docs/SecurityApi.md#get_security_interval_prices) | **GET** /securities/{identifier}/prices/intervals | Interval Stock Prices for Security
 *Intrinio::SecurityApi* | [**get_security_intraday_prices**](docs/SecurityApi.md#get_security_intraday_prices) | **GET** /securities/{identifier}/prices/intraday | Intraday Stock Prices for Security
 *Intrinio::SecurityApi* | [**get_security_latest_dividend_record**](docs/SecurityApi.md#get_security_latest_dividend_record) | **GET** /securities/{identifier}/dividends/latest | Latest Dividend Record for Security
@@ -459,6 +466,10 @@ Class | Method | HTTP request | Description
  - [Intrinio::OptionContractsList](docs/OptionContractsList.md)
  - [Intrinio::OptionEod](docs/OptionEod.md)
  - [Intrinio::OptionFactorsRealtime](docs/OptionFactorsRealtime.md)
+ - [Intrinio::OptionInterval](docs/OptionInterval.md)
+ - [Intrinio::OptionIntervalMover](docs/OptionIntervalMover.md)
+ - [Intrinio::OptionIntervalsMoversResult](docs/OptionIntervalsMoversResult.md)
+ - [Intrinio::OptionIntervalsResult](docs/OptionIntervalsResult.md)
  - [Intrinio::OptionPrice](docs/OptionPrice.md)
  - [Intrinio::OptionPriceBatchRealtime](docs/OptionPriceBatchRealtime.md)
  - [Intrinio::OptionPriceEod](docs/OptionPriceEod.md)
@@ -478,6 +489,8 @@ Class | Method | HTTP request | Description
  - [Intrinio::ReportedTag](docs/ReportedTag.md)
  - [Intrinio::SICIndex](docs/SICIndex.md)
  - [Intrinio::Security](docs/Security.md)
+ - [Intrinio::SecurityIntervalMover](docs/SecurityIntervalMover.md)
+ - [Intrinio::SecurityIntervalsMoversResult](docs/SecurityIntervalsMoversResult.md)
  - [Intrinio::SecurityScreenClause](docs/SecurityScreenClause.md)
  - [Intrinio::SecurityScreenGroup](docs/SecurityScreenGroup.md)
  - [Intrinio::SecurityScreenResult](docs/SecurityScreenResult.md)

data/docs/ApiResponseSecurityIntervalPrices.md

@@ -12,7 +12,7 @@
 
 Name | Type | Description
 ------------ | ------------- | -------------
-**intervals** | [**Array<StockPriceInterval>**](StockPriceInterval.md) | Open, High, Low, Close, and Volume for a particular interval  
+**intervals** | [**Array<StockPriceInterval>**](StockPriceInterval.md) | Open, close, high, low, volume, average price, and change ratio for a particular interval  
 **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier  
 **source** | String | The source of the data  
 **next_page** | String | The token required to request the next page of the data. If null, no further results are available.  

data/docs/OptionInterval.md

@@ -0,0 +1,28 @@
+
+
+[//]: # (CLASS:Intrinio::OptionInterval)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionInterval
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**open_time** | DateTime | The UTC timestamp for the time this interval opened.  
+**close_time** | DateTime | The UTC timestamp for the time this interval closed.  
+**open** | Float | The first traded contract price in this interval.  
+**high** | Float | The highest traded contract price in this interval.  
+**low** | Float | The lowest traded contract price in this interval.  
+**close** | Float | The last traded contract price in this interval.  
+**volume** | Float | The volume of contract trades in this interval.  
+**average** | Float | The volume weighted average price of contract trades in this interval.  
+**change** | Float | The ratio of Close minus Open to Open.  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OptionIntervalMover.md

@@ -0,0 +1,27 @@
+
+
+[//]: # (CLASS:Intrinio::OptionIntervalMover)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionIntervalMover
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**contract** | String | The option contract for the intervals  
+**change** | Float | The ratio of Close minus Open to Open.  
+**open** | Float | The first traded contract price in this interval.  
+**high** | Float | The highest traded contract price in this interval.  
+**low** | Float | The lowest traded contract price in this interval.  
+**close** | Float | The last traded contract price in this interval.  
+**volume** | Float | The volume of contract trades in this interval.  
+**average** | Float | The volume weighted average price of contract trades in this interval.  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OptionIntervalsMoversResult.md

@@ -0,0 +1,26 @@
+
+
+[//]: # (CLASS:Intrinio::OptionIntervalsMoversResult)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionIntervalsMoversResult
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**open_time** | DateTime | The UTC timestamp for the time this interval opened.  
+**close_time** | DateTime | The UTC timestamp for the time this interval closed.  
+**size** | String | The size of the time span for the interval.  
+**intervals** | [**Array<OptionIntervalMover>**](OptionIntervalMover.md) | Array of all the intervals in the result.  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionIntervalMover)
+
+
+

data/docs/OptionIntervalsResult.md

@@ -0,0 +1,25 @@
+
+
+[//]: # (CLASS:Intrinio::OptionIntervalsResult)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionIntervalsResult
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**intervals** | [**Array<OptionInterval>**](OptionInterval.md) | Array of all the intervals in the result.  
+**contract** | String | The option contract for the intervals  
+**size** | String | The size of the time span for the interval.  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionInterval)
+
+
+

data/docs/OptionUnusualTrade.md

@@ -15,7 +15,7 @@ Name | Type | Description
 **symbol** | String | The underlying option security symbol for the trade  
 **timestamp** | Date | The UTC timestamp of order placement  
 **type** | String | The type of unusual trade  
-**total_value** | Float | The aggregated value of all option contract premiums included in the trade\\  
+**total_value** | Float | The aggregated value of all option contract premiums included in the trade  
 **total_size** | Float | The total number of contracts involved in a single transaction  
 **average_price** | Float | The average premium paid per option contract  
 **contract** | String | The option contract symbol  

data/docs/OptionsApi.md

@@ -13,6 +13,10 @@ Method | HTTP request | Description
 [**get_options_chain_eod**](OptionsApi.md#get_options_chain_eod) | **GET** /options/chain/{symbol}/{expiration}/eod | Options Chain EOD
 [**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_interval_by_contract**](OptionsApi.md#get_options_interval_by_contract) | **GET** /options/interval/{identifier} | Options Intervals By Contract
+[**get_options_interval_movers**](OptionsApi.md#get_options_interval_movers) | **GET** /options/interval/movers | Options Intervals Movers
+[**get_options_interval_movers_change**](OptionsApi.md#get_options_interval_movers_change) | **GET** /options/interval/movers/change | Options Intervals Movers By Change
+[**get_options_interval_movers_volume**](OptionsApi.md#get_options_interval_movers_volume) | **GET** /options/interval/movers/volume | Options Intervals Movers By Volume
 [**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_eod**](OptionsApi.md#get_options_prices_eod) | **GET** /options/prices/{identifier}/eod | Option Prices EOD
@@ -831,6 +835,340 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_options_interval_by_contract)
+
+[//]: # (RETURN_TYPE:Intrinio::OptionIntervalsResult)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:OptionIntervalsResult.md)
+
+[//]: # (OPERATION:get_options_interval_by_contract_v2)
+
+[//]: # (ENDPOINT:/options/interval/{identifier})
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_interval_by_contract)
+
+## **get_options_interval_by_contract**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_options_interval_by_contract_v2)
+
+[//]: # (START_OVERVIEW)
+
+> OptionIntervalsResult get_options_interval_by_contract(identifier, interval_size, opts)
+
+#### Options Intervals By Contract
+
+
+Returns a list of interval data points for a contract.
+
+[//]: # (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 = "SPY___230103P00380000"
+interval_size = "5m"
+
+opts = {
+  source: nil,
+  page_size: 100,
+  end_time: DateTime.parse(nil)
+}
+
+result = options_api.get_options_interval_by_contract(identifier, interval_size, 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 intervals for. |   
+ **interval_size** | String| The time length of the interval. |   
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]   
+ **page_size** | Integer| The number of results to return | [optional] [default to 100]  
+ **end_time** | DateTime| The inclusive UTC date and time the intervals end at. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**OptionIntervalsResult**](OptionIntervalsResult.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_options_interval_movers)
+
+[//]: # (RETURN_TYPE:Intrinio::OptionIntervalsMoversResult)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:OptionIntervalsMoversResult.md)
+
+[//]: # (OPERATION:get_options_interval_movers_v2)
+
+[//]: # (ENDPOINT:/options/interval/movers)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_interval_movers)
+
+## **get_options_interval_movers**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_options_interval_movers_v2)
+
+[//]: # (START_OVERVIEW)
+
+> OptionIntervalsMoversResult get_options_interval_movers(opts)
+
+#### Options Intervals Movers
+
+
+Returns a list of intervals for the biggest movers over the last hour interval.
+
+[//]: # (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
+
+opts = {
+  source: nil,
+  open_time: DateTime.parse(nil)
+}
+
+result = options_api.get_options_interval_movers(opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]   
+ **open_time** | DateTime| The inclusive UTC date and time the interval opens at. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**OptionIntervalsMoversResult**](OptionIntervalsMoversResult.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_options_interval_movers_change)
+
+[//]: # (RETURN_TYPE:Intrinio::OptionIntervalsMoversResult)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:OptionIntervalsMoversResult.md)
+
+[//]: # (OPERATION:get_options_interval_movers_change_v2)
+
+[//]: # (ENDPOINT:/options/interval/movers/change)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_interval_movers_change)
+
+## **get_options_interval_movers_change**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_options_interval_movers_change_v2)
+
+[//]: # (START_OVERVIEW)
+
+> OptionIntervalsMoversResult get_options_interval_movers_change(opts)
+
+#### Options Intervals Movers By Change
+
+
+Returns a list of intervals for the biggest movers by change over the last hour interval.
+
+[//]: # (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
+
+opts = {
+  source: nil,
+  open_time: DateTime.parse(nil)
+}
+
+result = options_api.get_options_interval_movers_change(opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]   
+ **open_time** | DateTime| The inclusive UTC date and time the interval opens at. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**OptionIntervalsMoversResult**](OptionIntervalsMoversResult.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_options_interval_movers_volume)
+
+[//]: # (RETURN_TYPE:Intrinio::OptionIntervalsMoversResult)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:OptionIntervalsMoversResult.md)
+
+[//]: # (OPERATION:get_options_interval_movers_volume_v2)
+
+[//]: # (ENDPOINT:/options/interval/movers/volume)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_interval_movers_volume)
+
+## **get_options_interval_movers_volume**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_options_interval_movers_volume_v2)
+
+[//]: # (START_OVERVIEW)
+
+> OptionIntervalsMoversResult get_options_interval_movers_volume(opts)
+
+#### Options Intervals Movers By Volume
+
+
+Returns a list of intervals for the biggest movers by volume over the last hour interval.
+
+[//]: # (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
+
+opts = {
+  source: nil,
+  open_time: DateTime.parse(nil)
+}
+
+result = options_api.get_options_interval_movers_volume(opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]   
+ **open_time** | DateTime| The inclusive UTC date and time the interval opens at. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**OptionIntervalsMoversResult**](OptionIntervalsMoversResult.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::OptionsApi)

data/docs/RealtimeStockPrice.md

@@ -27,6 +27,11 @@ Name | Type | Description
 **market_volume** | Float | The number of shares exchanged during the trading day for the whole market.  
 **updated_on** | DateTime | The date and time when the data was last updated.  
 **source** | String | The source of the data.  
+**listing_venue** | String | The venue the price came from.  
+**sales_conditions** | String | The condition for the sale.  
+**quote_conditions** | String | The condition for the quote.  
+**market_center_code** | String | The market center character code.  
+**is_darkpool** | BOOLEAN | Whether or not the current trade is from a darkpool or not.  
 **security** | [**RealtimeStockPriceSecurity**](RealtimeStockPriceSecurity.md) |   
 
 [//]: # (END_DEFINITION)