intrinio-sdk 5.19.0 → 6.21.0

data/docs/OptionsApi.md

@@ -18,8 +18,11 @@ Method | HTTP request | Description
 [**get_options_prices_eod**](OptionsApi.md#get_options_prices_eod) | **GET** /options/prices/{identifier}/eod | Option Prices EOD
 [**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
+[**get_security_snapshots**](OptionsApi.md#get_security_snapshots) | **GET** /options/snapshots | Option Prices Realtime Snapshot
 [**get_unusual_activity**](OptionsApi.md#get_unusual_activity) | **GET** /options/unusual_activity/{symbol} | Options Unusual Activity
+[**get_unusual_activity_intraday**](OptionsApi.md#get_unusual_activity_intraday) | **GET** /options/unusual_activity/{symbol}/intraday | Options Unusual Activity Intraday
 [**get_unusual_activity_universal**](OptionsApi.md#get_unusual_activity_universal) | **GET** /options/unusual_activity | Options Unusual Activity Universal
+[**get_unusual_activity_universal_intraday**](OptionsApi.md#get_unusual_activity_universal_intraday) | **GET** /options/unusual_activity/intraday | Options Unusual Activity Universal Intraday
 
 
 
@@ -124,7 +127,7 @@ This endpoint does not need any parameter.
 #### Option Expirations Realtime
 
 
-Returns all realtime option contract expiration dates for a given symbol.
+Returns a list of all current and upcoming expiration dates for a particular symbol.
 
 [//]: # (END_OVERVIEW)
 
@@ -210,7 +213,7 @@ Name | Type | Description  | Notes
 #### Option Strikes Realtime
 
 
-Returns all realtime options contracts and their prices for the given symbol and strike.
+Returns a list of the latest top of the order book size and premium (bid / ask), the latest trade size and premium as well as the greeks and implied volatility for all call/put contracts that match the strike and symbol specified.
 
 [//]: # (END_OVERVIEW)
 
@@ -289,7 +292,7 @@ Name | Type | Description  | Notes
 #### Options
 
 
-Returns the master list of option contracts for a given symbol.
+Returns a list of all securities that have options listed and are tradable on a US market exchange. Useful to retrieve the entire universe.
 
 [//]: # (END_OVERVIEW)
 
@@ -387,7 +390,7 @@ Name | Type | Description  | Notes
 #### Options by Symbol Realtime
 
 
-Returns the master list of realtime option contracts for a given symbol.
+Returns a list of all securities that have options listed and are tradable on a US market exchange. Useful to retrieve the entire universe.
 
 [//]: # (END_OVERVIEW)
 
@@ -483,7 +486,7 @@ Name | Type | Description  | Notes
 #### Options Chain
 
 
-Returns all options contracts and their prices for the given symbol and expiration date.
+Returns a list of the historical end-of-day top of the order book size and premium (bid / ask), the latest trade size and premium as well as the greeks and implied volatility for all option contracts currently associated with the option chain.
 
 [//]: # (END_OVERVIEW)
 
@@ -606,7 +609,8 @@ opts = {
   type: nil,
   strike: nil,
   strike_greater_than: nil,
-  strike_less_than: nil
+  strike_less_than: nil,
+  date: nil
 }
 
 result = options_api.get_options_chain_eod(symbol, expiration, opts)
@@ -630,6 +634,7 @@ Name | Type | Description  | Notes
  **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]   
+ **date** | Date| The the date to retrieve prices for | [optional]   
 
 [//]: # (END_PARAMETERS)
 
@@ -669,7 +674,7 @@ Name | Type | Description  | Notes
 #### Options Chain Realtime
 
 
-Returns all realtime options contracts and their prices for the given symbol and expiration date.
+Returns a list of the latest National Best Bid & Offer (NBBO) top of the order book size and premium (bid / ask), the latest trade size and premium as well as the greeks and implied volatility for all option contracts currently associated with the option chain.
 
 [//]: # (END_OVERVIEW)
 
@@ -771,7 +776,7 @@ Name | Type | Description  | Notes
 #### Options Expirations
 
 
-Returns all option contract expiration dates for a given symbol.
+Returns a list of all current and upcoming option contract expiration dates for a particular symbol.
 
 [//]: # (END_OVERVIEW)
 
@@ -855,7 +860,7 @@ Name | Type | Description  | Notes
 #### Option Prices
 
 
-Returns all option prices for a given option contract identifier.
+Returns all price data from inception to expiration for a particular contract.
 
 [//]: # (END_OVERVIEW)
 
@@ -943,7 +948,7 @@ Name | Type | Description  | Notes
 #### Option Prices Batch Realtime
 
 
-Returns options prices for a supplied list of option symbols.
+Returns a list of latest price data for up to 250 option contracts per request.
 
 [//]: # (END_OVERVIEW)
 
@@ -1190,7 +1195,7 @@ Name | Type | Description  | Notes
 #### Option Stats Realtime
 
 
-Returns all option stats (greeks and implied volatility) and factors used to calculate them, for a given option contract identifier.
+Returns all option stats (greeks and implied volatility) as well as the underlying factors used to calculate them, for a particular option contract.
 
 [//]: # (END_OVERVIEW)
 
@@ -1243,6 +1248,88 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_security_snapshots)
+
+[//]: # (RETURN_TYPE:Intrinio::OptionSnapshotsResult)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:OptionSnapshotsResult.md)
+
+[//]: # (OPERATION:get_security_snapshots_v2)
+
+[//]: # (ENDPOINT:/options/snapshots)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_security_snapshots)
+
+## **get_security_snapshots**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_snapshots_v2)
+
+[//]: # (START_OVERVIEW)
+
+> OptionSnapshotsResult get_security_snapshots(opts)
+
+#### Option Prices Realtime Snapshot
+
+
+Returns all options snapshots for the queried interval with links to download.
+
+[//]: # (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,
+  at_datetime: DateTime.parse(nil)
+}
+
+result = options_api.get_security_snapshots(opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]   
+ **at_datetime** | DateTime| The UTC date and time (with url-encoded spaces) the snapshot will cover. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**OptionSnapshotsResult**](OptionSnapshotsResult.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::OptionsApi)
@@ -1272,7 +1359,7 @@ Name | Type | Description  | Notes
 #### Options Unusual Activity
 
 
-Returns unusual trades for a given identifier.
+Returns unusual options activity for a particular company across all option chains. Unusual options activity includes large trades, sweeps, and block trades.
 
 [//]: # (END_OVERVIEW)
 
@@ -1325,6 +1412,102 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_unusual_activity_intraday)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsUnusualActivity)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsUnusualActivity.md)
+
+[//]: # (OPERATION:get_unusual_activity_intraday_v2)
+
+[//]: # (ENDPOINT:/options/unusual_activity/{symbol}/intraday)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_unusual_activity_intraday)
+
+## **get_unusual_activity_intraday**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_unusual_activity_intraday_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsUnusualActivity get_unusual_activity_intraday(symbol, opts)
+
+#### Options Unusual Activity Intraday
+
+
+Returns unusual trades for a given identifier within the query parameters.
+
+[//]: # (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 = {
+  next_page: nil,
+  page_size: 1000,
+  activity_type: nil,
+  sentiment: nil,
+  start_date: Date.parse("2022-02-01"),
+  end_date: Date.parse("2022-02-03"),
+  minimum_total_value: 100000.0,
+  maximum_total_value: 200000.0
+}
+
+result = options_api.get_unusual_activity_intraday(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. |   
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]   
+ **page_size** | Integer| The number of results to return | [optional] [default to 1000]  
+ **activity_type** | String| The unusual activity type to query for. | [optional]   
+ **sentiment** | String| The sentiment type to query for. | [optional]   
+ **start_date** | Date| Return unusual activity on or after this date. | [optional]   
+ **end_date** | Date| Return unusual activity on or before this date. | [optional]   
+ **minimum_total_value** | [**Object**](.md)| The inclusive minimum total value for the unusual activity. | [optional]   
+ **maximum_total_value** | [**Object**](.md)| The inclusive maximum total value for the unusual activity. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsUnusualActivity**](ApiResponseOptionsUnusualActivity.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::OptionsApi)
@@ -1354,7 +1537,7 @@ Name | Type | Description  | Notes
 #### Options Unusual Activity Universal
 
 
-Returns nusual trades for all underlying security symbols.
+Returns the latest unusual options activity across all US companies with across all option chains. Unusual options activity includes large trades, sweeps, and block trades.
 
 [//]: # (END_OVERVIEW)
 
@@ -1404,3 +1587,97 @@ Name | Type | Description  | Notes
 
 [//]: # (END_OPERATION)
 
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_unusual_activity_universal_intraday)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsUnusualActivity)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsUnusualActivity.md)
+
+[//]: # (OPERATION:get_unusual_activity_universal_intraday_v2)
+
+[//]: # (ENDPOINT:/options/unusual_activity/intraday)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_unusual_activity_universal_intraday)
+
+## **get_unusual_activity_universal_intraday**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_unusual_activity_universal_intraday_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsUnusualActivity get_unusual_activity_universal_intraday(opts)
+
+#### Options Unusual Activity Universal Intraday
+
+
+Returns unusual trades for all underlying security symbols within the query parameters.
+
+[//]: # (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 = {
+  next_page: nil,
+  page_size: 1000,
+  activity_type: nil,
+  sentiment: nil,
+  start_date: Date.parse("2022-02-01"),
+  end_date: Date.parse("2022-02-03"),
+  minimum_total_value: 100000.0,
+  maximum_total_value: 200000.0
+}
+
+result = options_api.get_unusual_activity_universal_intraday(opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]   
+ **page_size** | Integer| The number of results to return | [optional] [default to 1000]  
+ **activity_type** | String| The unusual activity type to query for. | [optional]   
+ **sentiment** | String| The sentiment type to query for. | [optional]   
+ **start_date** | Date| Return unusual activity on or after this date. | [optional]   
+ **end_date** | Date| Return unusual activity on or before this date. | [optional]   
+ **minimum_total_value** | [**Object**](.md)| The inclusive minimum total value for the unusual activity. | [optional]   
+ **maximum_total_value** | [**Object**](.md)| The inclusive maximum total value for the unusual activity. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsUnusualActivity**](ApiResponseOptionsUnusualActivity.md)
+
+[//]: # (END_OPERATION)
+

data/docs/OwnersApi.md

@@ -314,7 +314,7 @@ identifier = 430692
 
 opts = {
   page_size: 100,
-  as_of_date: "2021-01-05",
+  as_of_date: Date.parse("2021-01-05"),
   next_page: nil
 }
 
@@ -335,7 +335,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **identifier** | String| The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under. |   
  **page_size** | Integer| The number of results to return | [optional] [default to 100]  
- **as_of_date** | [**Object**](.md)| Return only holdings filed before this date. | [optional]   
+ **as_of_date** | Date| Return only holdings filed before this date. | [optional]   
  **next_page** | String| Gets the next page of data from a previous API call | [optional]   
 
 [//]: # (END_PARAMETERS)