intrinio-sdk 6.34.0 → 6.36.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.76.3
+OpenAPI spec version: 2.100.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -1034,6 +1034,74 @@ module Intrinio
       return data, status_code, headers
     end
 
+    # Options Implied Move By Symbol
+    # Returns the implied move data points for a ticker symbol.
+    # @param symbol The ticker symbol for the contracts.
+    # @param expiration_date The expiration date for the contracts to consider.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Object] :percentage Percentage to multiply the straddle by. Defaults to 0.85.
+    # @option opts [String] :source Realtime or 15-minute delayed contracts.
+    # @return [ApiResponseOptionsImpliedMove]
+    def get_options_implied_move_by_symbol(symbol, expiration_date, opts = {})
+      data, _status_code, _headers = get_options_implied_move_by_symbol_with_http_info(symbol, expiration_date, opts)
+      return data
+    end
+
+    # Options Implied Move By Symbol
+    # Returns the implied move data points for a ticker symbol.
+    # @param symbol The ticker symbol for the contracts.
+    # @param expiration_date The expiration date for the contracts to consider.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Object] :percentage Percentage to multiply the straddle by. Defaults to 0.85.
+    # @option opts [String] :source Realtime or 15-minute delayed contracts.
+    # @return [Array<(ApiResponseOptionsImpliedMove, Fixnum, Hash)>] ApiResponseOptionsImpliedMove data, response status code and response headers
+    def get_options_implied_move_by_symbol_with_http_info(symbol, expiration_date, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OptionsApi.get_options_implied_move_by_symbol ..."
+      end
+      # verify the required parameter 'symbol' is set
+      if @api_client.config.client_side_validation && symbol.nil?
+        fail ArgumentError, "Missing the required parameter 'symbol' when calling OptionsApi.get_options_implied_move_by_symbol"
+      end
+      # verify the required parameter 'expiration_date' is set
+      if @api_client.config.client_side_validation && expiration_date.nil?
+        fail ArgumentError, "Missing the required parameter 'expiration_date' when calling OptionsApi.get_options_implied_move_by_symbol"
+      end
+      if @api_client.config.client_side_validation && opts[:'source'] && !['realtime', 'delayed'].include?(opts[:'source'])
+        fail ArgumentError, 'invalid value for "source", must be one of realtime, delayed'
+      end
+      # resource path
+      local_var_path = "/options/implied_move/{symbol}/{expiration_date}".sub('{' + 'symbol' + '}', symbol.to_s).sub('{' + 'expiration_date' + '}', expiration_date.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'percentage'] = opts[:'percentage'] if !opts[:'percentage'].nil?
+      query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ApiResponseOptionsImpliedMove')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OptionsApi#get_options_implied_move_by_symbol\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Options Intervals By Contract
     # Returns a list of interval data points for a contract.
     # @param identifier The Intrinio ID or code of the options contract to request intervals for.
@@ -1663,6 +1731,7 @@ module Intrinio
     # @option opts [BOOLEAN] :show_extended_price Whether to include open close high low type fields.
     # @option opts [Object] :expiration_start_date Filter out contracts that expire before this date.
     # @option opts [Object] :expiration_end_date Filter out contracts that expire after this date.
+    # @option opts [Float] :strike Filter out contracts that have this strike price.
     # @return [ApiResponseOptionsPricesByTickerRealtime]
     def get_options_prices_realtime_by_ticker(symbol, opts = {})
       data, _status_code, _headers = get_options_prices_realtime_by_ticker_with_http_info(symbol, opts)
@@ -1682,6 +1751,7 @@ module Intrinio
     # @option opts [BOOLEAN] :show_extended_price Whether to include open close high low type fields.
     # @option opts [Object] :expiration_start_date Filter out contracts that expire before this date.
     # @option opts [Object] :expiration_end_date Filter out contracts that expire after this date.
+    # @option opts [Float] :strike Filter out contracts that have this strike price.
     # @return [Array<(ApiResponseOptionsPricesByTickerRealtime, Fixnum, Hash)>] ApiResponseOptionsPricesByTickerRealtime data, response status code and response headers
     def get_options_prices_realtime_by_ticker_with_http_info(symbol, opts = {})
       if @api_client.config.debugging
@@ -1721,6 +1791,7 @@ module Intrinio
       query_params[:'show_extended_price'] = opts[:'show_extended_price'] if !opts[:'show_extended_price'].nil?
       query_params[:'expiration_start_date'] = opts[:'expiration_start_date'] if !opts[:'expiration_start_date'].nil?
       query_params[:'expiration_end_date'] = opts[:'expiration_end_date'] if !opts[:'expiration_end_date'].nil?
+      query_params[:'strike'] = opts[:'strike'] if !opts[:'strike'].nil?
 
       # header parameters
       header_params = {}
@@ -1751,6 +1822,9 @@ module Intrinio
     # @param [Hash] opts the optional parameters
     # @option opts [String] :source Realtime or 15-minute delayed contracts.
     # @option opts [DateTime] :at_datetime The UTC date and time (with url-encoded spaces) the snapshot will cover.
+    # @option opts [BOOLEAN] :with_greeks Whether to include Greek calculations fields when available.
+    # @option opts [String] :stock_price_source Source for underlying price for calculating Greeks.
+    # @option opts [BOOLEAN] :with_underlying_price Whether to include the underlying price of the security in the file.
     # @return [OptionSnapshotsResult]
     def get_options_snapshots(opts = {})
       data, _status_code, _headers = get_options_snapshots_with_http_info(opts)
@@ -1762,6 +1836,9 @@ module Intrinio
     # @param [Hash] opts the optional parameters
     # @option opts [String] :source Realtime or 15-minute delayed contracts.
     # @option opts [DateTime] :at_datetime The UTC date and time (with url-encoded spaces) the snapshot will cover.
+    # @option opts [BOOLEAN] :with_greeks Whether to include Greek calculations fields when available.
+    # @option opts [String] :stock_price_source Source for underlying price for calculating Greeks.
+    # @option opts [BOOLEAN] :with_underlying_price Whether to include the underlying price of the security in the file.
     # @return [Array<(OptionSnapshotsResult, Fixnum, Hash)>] OptionSnapshotsResult data, response status code and response headers
     def get_options_snapshots_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1770,6 +1847,9 @@ module Intrinio
       if @api_client.config.client_side_validation && opts[:'source'] && !['realtime', 'delayed'].include?(opts[:'source'])
         fail ArgumentError, 'invalid value for "source", must be one of realtime, delayed'
       end
+      if @api_client.config.client_side_validation && opts[:'stock_price_source'] && !['iex', 'nasdaq_basic', 'nasdaq_basic_last_sale'].include?(opts[:'stock_price_source'])
+        fail ArgumentError, 'invalid value for "stock_price_source", must be one of iex, nasdaq_basic, nasdaq_basic_last_sale'
+      end
       # resource path
       local_var_path = "/options/snapshots"
 
@@ -1777,6 +1857,9 @@ module Intrinio
       query_params = {}
       query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
       query_params[:'at_datetime'] = opts[:'at_datetime'] if !opts[:'at_datetime'].nil?
+      query_params[:'with_greeks'] = opts[:'with_greeks'] if !opts[:'with_greeks'].nil?
+      query_params[:'stock_price_source'] = opts[:'stock_price_source'] if !opts[:'stock_price_source'].nil?
+      query_params[:'with_underlying_price'] = opts[:'with_underlying_price'] if !opts[:'with_underlying_price'].nil?
 
       # header parameters
       header_params = {}
@@ -1932,7 +2015,7 @@ module Intrinio
     # @option opts [String] :activity_type The unusual activity type to query for.
     # @option opts [String] :sentiment The sentiment type to query for.
     # @option opts [Date] :start_date Return unusual activity on or after this date.
-    # @option opts [Date] :end_date Return unusual activity on or before this date.
+    # @option opts [Date] :end_date Return unusual activity before this date.
     # @option opts [Object] :minimum_total_value The inclusive minimum total value for the unusual activity.
     # @option opts [Object] :maximum_total_value The inclusive maximum total value for the unusual activity.
     # @return [ApiResponseOptionsUnusualActivity]
@@ -1950,7 +2033,7 @@ module Intrinio
     # @option opts [String] :activity_type The unusual activity type to query for.
     # @option opts [String] :sentiment The sentiment type to query for.
     # @option opts [Date] :start_date Return unusual activity on or after this date.
-    # @option opts [Date] :end_date Return unusual activity on or before this date.
+    # @option opts [Date] :end_date Return unusual activity before this date.
     # @option opts [Object] :minimum_total_value The inclusive minimum total value for the unusual activity.
     # @option opts [Object] :maximum_total_value The inclusive maximum total value for the unusual activity.
     # @return [Array<(ApiResponseOptionsUnusualActivity, Fixnum, Hash)>] ApiResponseOptionsUnusualActivity data, response status code and response headers
@@ -2071,7 +2154,7 @@ module Intrinio
     # @option opts [String] :activity_type The unusual activity type to query for.
     # @option opts [String] :sentiment The sentiment type to query for.
     # @option opts [Date] :start_date Return unusual activity on or after this date.
-    # @option opts [Date] :end_date Return unusual activity on or before this date.
+    # @option opts [Date] :end_date Return unusual activity before this date.
     # @option opts [Object] :minimum_total_value The inclusive minimum total value for the unusual activity.
     # @option opts [Object] :maximum_total_value The inclusive maximum total value for the unusual activity.
     # @return [ApiResponseOptionsUnusualActivity]
@@ -2088,7 +2171,7 @@ module Intrinio
     # @option opts [String] :activity_type The unusual activity type to query for.
     # @option opts [String] :sentiment The sentiment type to query for.
     # @option opts [Date] :start_date Return unusual activity on or after this date.
-    # @option opts [Date] :end_date Return unusual activity on or before this date.
+    # @option opts [Date] :end_date Return unusual activity before this date.
     # @option opts [Object] :minimum_total_value The inclusive minimum total value for the unusual activity.
     # @option opts [Object] :maximum_total_value The inclusive maximum total value for the unusual activity.
     # @return [Array<(ApiResponseOptionsUnusualActivity, Fixnum, Hash)>] ApiResponseOptionsUnusualActivity data, response status code and response headers
@@ -2143,5 +2226,177 @@ module Intrinio
       end
       return data, status_code, headers
     end
+
+    # Get realtime options greeks by ticker
+    # Retrieves realtime options greeks data for all contracts of a given ticker symbol
+    # @param identifier The ticker symbol to get options greeks for
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :source The data source to use for options data
+    # @option opts [String] :model The options pricing model to use for greeks calculations (default to black_scholes)
+    # @option opts [String] :iv_mode The implied volatility calculation mode
+    # @option opts [String] :stock_price_source The data source to use for underlying stock prices
+    # @option opts [Date] :expiration_start_date Filter options by expiration date (start)
+    # @option opts [Date] :expiration_end_date Filter options by expiration date (end)
+    # @option opts [Float] :strike Filter options by strike price
+    # @option opts [Float] :strike_greater_than Filter options by minimum strike price
+    # @option opts [Float] :strike_less_than Filter options by maximum strike price
+    # @option opts [Integer] :page_size Number of results to return per page (default to 250)
+    # @return [ApiResponseOptionsGreeksByTickerRealtime]
+    def options_greeks_by_ticker_identifier_realtime_get(identifier, opts = {})
+      data, _status_code, _headers = options_greeks_by_ticker_identifier_realtime_get_with_http_info(identifier, opts)
+      return data
+    end
+
+    # Get realtime options greeks by ticker
+    # Retrieves realtime options greeks data for all contracts of a given ticker symbol
+    # @param identifier The ticker symbol to get options greeks for
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :source The data source to use for options data
+    # @option opts [String] :model The options pricing model to use for greeks calculations
+    # @option opts [String] :iv_mode The implied volatility calculation mode
+    # @option opts [String] :stock_price_source The data source to use for underlying stock prices
+    # @option opts [Date] :expiration_start_date Filter options by expiration date (start)
+    # @option opts [Date] :expiration_end_date Filter options by expiration date (end)
+    # @option opts [Float] :strike Filter options by strike price
+    # @option opts [Float] :strike_greater_than Filter options by minimum strike price
+    # @option opts [Float] :strike_less_than Filter options by maximum strike price
+    # @option opts [Integer] :page_size Number of results to return per page
+    # @return [Array<(ApiResponseOptionsGreeksByTickerRealtime, Fixnum, Hash)>] ApiResponseOptionsGreeksByTickerRealtime data, response status code and response headers
+    def options_greeks_by_ticker_identifier_realtime_get_with_http_info(identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OptionsApi.options_greeks_by_ticker_identifier_realtime_get ..."
+      end
+      # verify the required parameter 'identifier' is set
+      if @api_client.config.client_side_validation && identifier.nil?
+        fail ArgumentError, "Missing the required parameter 'identifier' when calling OptionsApi.options_greeks_by_ticker_identifier_realtime_get"
+      end
+      if @api_client.config.client_side_validation && opts[:'source'] && !['realtime', 'delayed'].include?(opts[:'source'])
+        fail ArgumentError, 'invalid value for "source", must be one of realtime, delayed'
+      end
+      if @api_client.config.client_side_validation && opts[:'model'] && !['black_scholes', 'bjerk'].include?(opts[:'model'])
+        fail ArgumentError, 'invalid value for "model", must be one of black_scholes, bjerk'
+      end
+      if @api_client.config.client_side_validation && opts[:'iv_mode'] && !['out_of_the_money'].include?(opts[:'iv_mode'])
+        fail ArgumentError, 'invalid value for "iv_mode", must be one of out_of_the_money'
+      end
+      if @api_client.config.client_side_validation && opts[:'stock_price_source'] && !['iex', 'nasdaq_basic', 'nasdaq_basic_last_sale', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'otc_delayed', 'delayed_sip'].include?(opts[:'stock_price_source'])
+        fail ArgumentError, 'invalid value for "stock_price_source", must be one of iex, nasdaq_basic, nasdaq_basic_last_sale, bats_delayed, utp_delayed, cta_a_delayed, cta_b_delayed, otc_delayed, delayed_sip'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 2500
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling OptionsApi.options_greeks_by_ticker_identifier_realtime_get, must be smaller than or equal to 2500.'
+      end
+
+      # resource path
+      local_var_path = "/options/greeks/by_ticker/{identifier}/realtime".sub('{' + 'identifier' + '}', identifier.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
+      query_params[:'model'] = opts[:'model'] if !opts[:'model'].nil?
+      query_params[:'iv_mode'] = opts[:'iv_mode'] if !opts[:'iv_mode'].nil?
+      query_params[:'stock_price_source'] = opts[:'stock_price_source'] if !opts[:'stock_price_source'].nil?
+      query_params[:'expiration_start_date'] = opts[:'expiration_start_date'] if !opts[:'expiration_start_date'].nil?
+      query_params[:'expiration_end_date'] = opts[:'expiration_end_date'] if !opts[:'expiration_end_date'].nil?
+      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[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+
+      # header parameters
+      header_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ApiResponseOptionsGreeksByTickerRealtime')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OptionsApi#options_greeks_by_ticker_identifier_realtime_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get realtime options greeks for a specific contract
+    # Retrieves realtime options greeks data for a specific options contract
+    # @param contract The options contract identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :source The data source to use for options data
+    # @option opts [String] :model The options pricing model to use for greeks calculations (default to black_scholes)
+    # @option opts [String] :iv_mode The implied volatility calculation mode
+    # @option opts [String] :stock_price_source The data source to use for underlying stock prices
+    # @return [ApiResponseOptionsGreekContractRealtime]
+    def options_greeks_contract_realtime_get(contract, opts = {})
+      data, _status_code, _headers = options_greeks_contract_realtime_get_with_http_info(contract, opts)
+      return data
+    end
+
+    # Get realtime options greeks for a specific contract
+    # Retrieves realtime options greeks data for a specific options contract
+    # @param contract The options contract identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :source The data source to use for options data
+    # @option opts [String] :model The options pricing model to use for greeks calculations
+    # @option opts [String] :iv_mode The implied volatility calculation mode
+    # @option opts [String] :stock_price_source The data source to use for underlying stock prices
+    # @return [Array<(ApiResponseOptionsGreekContractRealtime, Fixnum, Hash)>] ApiResponseOptionsGreekContractRealtime data, response status code and response headers
+    def options_greeks_contract_realtime_get_with_http_info(contract, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OptionsApi.options_greeks_contract_realtime_get ..."
+      end
+      # verify the required parameter 'contract' is set
+      if @api_client.config.client_side_validation && contract.nil?
+        fail ArgumentError, "Missing the required parameter 'contract' when calling OptionsApi.options_greeks_contract_realtime_get"
+      end
+      if @api_client.config.client_side_validation && opts[:'source'] && !['realtime', 'delayed'].include?(opts[:'source'])
+        fail ArgumentError, 'invalid value for "source", must be one of realtime, delayed'
+      end
+      if @api_client.config.client_side_validation && opts[:'model'] && !['black_scholes', 'bjerk'].include?(opts[:'model'])
+        fail ArgumentError, 'invalid value for "model", must be one of black_scholes, bjerk'
+      end
+      if @api_client.config.client_side_validation && opts[:'iv_mode'] && !['out_of_the_money'].include?(opts[:'iv_mode'])
+        fail ArgumentError, 'invalid value for "iv_mode", must be one of out_of_the_money'
+      end
+      if @api_client.config.client_side_validation && opts[:'stock_price_source'] && !['iex', 'nasdaq_basic', 'nasdaq_basic_last_sale', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'otc_delayed', 'delayed_sip'].include?(opts[:'stock_price_source'])
+        fail ArgumentError, 'invalid value for "stock_price_source", must be one of iex, nasdaq_basic, nasdaq_basic_last_sale, bats_delayed, utp_delayed, cta_a_delayed, cta_b_delayed, otc_delayed, delayed_sip'
+      end
+      # resource path
+      local_var_path = "/options/greeks/{contract}/realtime".sub('{' + 'contract' + '}', contract.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
+      query_params[:'model'] = opts[:'model'] if !opts[:'model'].nil?
+      query_params[:'iv_mode'] = opts[:'iv_mode'] if !opts[:'iv_mode'].nil?
+      query_params[:'stock_price_source'] = opts[:'stock_price_source'] if !opts[:'stock_price_source'].nil?
+
+      # header parameters
+      header_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ApiResponseOptionsGreekContractRealtime')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OptionsApi#options_greeks_contract_realtime_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

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