options_api_spec.rb in intrinio-sdk-5.21.0

- old
+ new

@@ -1,11 +1,11 @@
 =begin
 #Intrinio API
 
 #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
 
 =end
@@ -43,11 +43,11 @@
     end
   end
 
   # unit tests for get_option_expirations_realtime
   # 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.
   # @option opts [String] :before Return option contract expiration dates before this date.
   # @option opts [String] :source Realtime or 15-minute delayed contracts.
@@ -58,11 +58,11 @@
     end
   end
 
   # unit tests for get_option_strikes_realtime
   # 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
   # @return [ApiResponseOptionsChainRealtime]
   describe 'get_option_strikes_realtime test' do
@@ -71,11 +71,11 @@
     end
   end
 
   # unit tests for get_options
   # 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.
   # @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.
@@ -92,11 +92,11 @@
     end
   end
 
   # unit tests for get_options_by_symbol_realtime
   # 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.
   # @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.
@@ -112,11 +112,11 @@
     end
   end
 
   # unit tests for get_options_chain
   # 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
   # @option opts [Date] :date The date of the option price. Returns option prices on this date.
   # @option opts [String] :type The option contract type.
@@ -140,20 +140,21 @@
   # @param [Hash] opts the optional parameters
   # @option opts [String] :type The option contract type.
   # @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]
   describe 'get_options_chain_eod test' do
     it "should work" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_options_chain_realtime
   # 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
   # @option opts [String] :source Realtime or 15-minute delayed contracts.
   # @option opts [String] :type The option contract type.
@@ -172,11 +173,11 @@
     end
   end
 
   # unit tests for get_options_expirations
   # 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.
   # @option opts [String] :before Return option contract expiration dates before this date.
   # @return [ApiResponseOptionsExpirations]
@@ -186,11 +187,11 @@
     end
   end
 
   # unit tests for get_options_prices
   # 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.
   # @option opts [String] :end_date Return option contract prices on or before this date.
   # @option opts [Integer] :page_size The number of results to return
@@ -202,11 +203,11 @@
     end
   end
 
   # unit tests for get_options_prices_batch_realtime
   # 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.
   # @return [ApiResponseOptionsPricesBatchRealtime]
   describe 'get_options_prices_batch_realtime test' do
@@ -240,11 +241,11 @@
     end
   end
 
   # unit tests for get_options_stats_realtime
   # 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.
   # @return [ApiResponseOptionsStatsRealtime]
   describe 'get_options_stats_realtime test' do
@@ -253,11 +254,11 @@
     end
   end
 
   # unit tests for get_unusual_activity
   # 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.
   # @return [ApiResponseOptionsUnusualActivity]
   describe 'get_unusual_activity test' do
@@ -286,10 +287,10 @@
     end
   end
 
   # unit tests for get_unusual_activity_universal
   # 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]
   describe 'get_unusual_activity_universal test' do
     it "should work" do