intrinio-sdk 5.20.0 → 5.21.0

data/lib/intrinio-sdk/api/options_api.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://docs.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.27.5
+OpenAPI spec version: 2.28.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -68,7 +68,7 @@ module Intrinio
     end
 
     # 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :after Return option contract expiration dates after this date.
@@ -81,7 +81,7 @@ module Intrinio
     end
 
     # 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :after Return option contract expiration dates after this date.
@@ -133,7 +133,7 @@ module Intrinio
     end
 
     # 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param strike The strike price of the option contract. This will return options contracts with strike price equal to this price.
     # @param [Hash] opts the optional parameters
@@ -144,7 +144,7 @@ module Intrinio
     end
 
     # 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param strike The strike price of the option contract. This will return options contracts with strike price equal to this price.
     # @param [Hash] opts the optional parameters
@@ -192,7 +192,7 @@ module Intrinio
     end
 
     # 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :type The option contract type.
@@ -211,7 +211,7 @@ module Intrinio
     end
 
     # 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :type The option contract type.
@@ -279,7 +279,7 @@ module Intrinio
     end
 
     # 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :type The option contract type.
@@ -297,7 +297,7 @@ module Intrinio
     end
 
     # 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :type The option contract type.
@@ -362,7 +362,7 @@ module Intrinio
     end
 
     # 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param expiration The expiration date of the options contract
     # @param [Hash] opts the optional parameters
@@ -380,7 +380,7 @@ module Intrinio
     end
 
     # 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param expiration The expiration date of the options contract
     # @param [Hash] opts the optional parameters
@@ -460,6 +460,7 @@ module Intrinio
     # @option opts [Float] :strike The strike price of the option contract. This will return options contracts with strike price equal to this price.
     # @option opts [Float] :strike_greater_than The strike price of the option contract. This will return options contracts with strike prices greater than this price.
     # @option opts [Float] :strike_less_than The strike price of the option contract. This will return options contracts with strike prices less than this price.
+    # @option opts [Date] :date The the date to retrieve prices for
     # @return [ApiResponseOptionsChainEod]
     def get_options_chain_eod(symbol, expiration, opts = {})
       data, _status_code, _headers = get_options_chain_eod_with_http_info(symbol, expiration, opts)
@@ -475,6 +476,7 @@ module Intrinio
     # @option opts [Float] :strike The strike price of the option contract. This will return options contracts with strike price equal to this price.
     # @option opts [Float] :strike_greater_than The strike price of the option contract. This will return options contracts with strike prices greater than this price.
     # @option opts [Float] :strike_less_than The strike price of the option contract. This will return options contracts with strike prices less than this price.
+    # @option opts [Date] :date The the date to retrieve prices for
     # @return [Array<(ApiResponseOptionsChainEod, Fixnum, Hash)>] ApiResponseOptionsChainEod data, response status code and response headers
     def get_options_chain_eod_with_http_info(symbol, expiration, opts = {})
       if @api_client.config.debugging
@@ -500,6 +502,7 @@ module Intrinio
       query_params[:'strike'] = opts[:'strike'] if !opts[:'strike'].nil?
       query_params[:'strike_greater_than'] = opts[:'strike_greater_than'] if !opts[:'strike_greater_than'].nil?
       query_params[:'strike_less_than'] = opts[:'strike_less_than'] if !opts[:'strike_less_than'].nil?
+      query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
 
       # header parameters
       header_params = {}
@@ -526,7 +529,7 @@ module Intrinio
     end
 
     # 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param expiration The expiration date of the options contract
     # @param [Hash] opts the optional parameters
@@ -547,7 +550,7 @@ module Intrinio
     end
 
     # 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 &amp; 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param expiration The expiration date of the options contract
     # @param [Hash] opts the optional parameters
@@ -624,7 +627,7 @@ module Intrinio
     end
 
     # 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :after Return option contract expiration dates after this date.
@@ -636,7 +639,7 @@ module Intrinio
     end
 
     # 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :after Return option contract expiration dates after this date.
@@ -683,7 +686,7 @@ module Intrinio
     end
 
     # Option Prices
-    # Returns all option prices for a given option contract identifier.
+    # Returns all price data from inception to expiration for a particular contract.
     # @param identifier The Intrinio ID or code of the options contract to request prices for.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :start_date Return option contract prices on or after this date.
@@ -697,7 +700,7 @@ module Intrinio
     end
 
     # Option Prices
-    # Returns all option prices for a given option contract identifier.
+    # Returns all price data from inception to expiration for a particular contract.
     # @param identifier The Intrinio ID or code of the options contract to request prices for.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :start_date Return option contract prices on or after this date.
@@ -752,7 +755,7 @@ module Intrinio
     end
 
     # 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.
     # @param body The contract symbols for which to return options prices for.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :source Realtime or 15-minute delayed contracts.
@@ -763,7 +766,7 @@ module Intrinio
     end
 
     # 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.
     # @param body The contract symbols for which to return options prices for.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :source Realtime or 15-minute delayed contracts.
@@ -925,7 +928,7 @@ module Intrinio
     end
 
     # 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.
     # @param identifier The Intrinio ID or code of the options contract to request prices for.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :source Realtime or 15-minute delayed contracts.
@@ -936,7 +939,7 @@ module Intrinio
     end
 
     # 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.
     # @param identifier The Intrinio ID or code of the options contract to request prices for.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :source Realtime or 15-minute delayed contracts.
@@ -984,7 +987,7 @@ module Intrinio
     end
 
     # 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :source Realtime or 15-minute delayed contracts.
@@ -995,7 +998,7 @@ module Intrinio
     end
 
     # 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.
     # @param symbol The option symbol, corresponding to the underlying security.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :source Realtime or 15-minute delayed contracts.
@@ -1130,7 +1133,7 @@ module Intrinio
     end
 
     # 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.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :source Realtime or 15-minute delayed contracts.
     # @return [ApiResponseOptionsUnusualActivity]
@@ -1140,7 +1143,7 @@ module Intrinio
     end
 
     # 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.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :source Realtime or 15-minute delayed contracts.
     # @return [Array<(ApiResponseOptionsUnusualActivity, Fixnum, Hash)>] ApiResponseOptionsUnusualActivity data, response status code and response headers

data/lib/intrinio-sdk/api/owners_api.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://docs.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.27.5
+OpenAPI spec version: 2.28.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -207,7 +207,7 @@ module Intrinio
     # @param identifier The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size The number of results to return (default to 100)
-    # @option opts [Object] :as_of_date Return only holdings filed before this date.
+    # @option opts [Date] :as_of_date Return only holdings filed before this date.
     # @option opts [String] :next_page Gets the next page of data from a previous API call
     # @return [ApiResponseOwnerInstitutionalHoldings]
     def institutional_holdings_by_owner(identifier, opts = {})
@@ -220,7 +220,7 @@ module Intrinio
     # @param identifier The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size The number of results to return
-    # @option opts [Object] :as_of_date Return only holdings filed before this date.
+    # @option opts [Date] :as_of_date Return only holdings filed before this date.
     # @option opts [String] :next_page Gets the next page of data from a previous API call
     # @return [Array<(ApiResponseOwnerInstitutionalHoldings, Fixnum, Hash)>] ApiResponseOwnerInstitutionalHoldings data, response status code and response headers
     def institutional_holdings_by_owner_with_http_info(identifier, opts = {})