intrinio-sdk 5.20.0 → 6.21.1

data/lib/intrinio-sdk/api/fundamentals_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.29.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -20,8 +20,94 @@ module Intrinio
       @api_client = api_client
     end
 
+    # Filter Fundamental
+    # Returns fundamentals that meet the set of filters specified in parameters.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Date] :filed_after Only include fundamentals that were filed on or after this date.
+    # @option opts [Date] :filed_before Only include fundamentals that were filed on or before this date.
+    # @option opts [BOOLEAN] :reported_only Only as-reported fundamentals
+    # @option opts [Integer] :fiscal_year Only for the given fiscal year
+    # @option opts [String] :statement_code Only of the given statement code
+    # @option opts [String] :type Only of the given type
+    # @option opts [String] :fiscal_period The fiscal period
+    # @option opts [Date] :start_date Only include fundamentals where covered period is on or after this date.
+    # @option opts [Date] :end_date Only include fundamentals where covered period is on or before this date.
+    # @option opts [String] :next_page Gets the next page of data from a previous API call
+    # @return [Fundamental]
+    def filter_fundamental(opts = {})
+      data, _status_code, _headers = filter_fundamental_with_http_info(opts)
+      return data
+    end
+
+    # Filter Fundamental
+    # Returns fundamentals that meet the set of filters specified in parameters.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Date] :filed_after Only include fundamentals that were filed on or after this date.
+    # @option opts [Date] :filed_before Only include fundamentals that were filed on or before this date.
+    # @option opts [BOOLEAN] :reported_only Only as-reported fundamentals
+    # @option opts [Integer] :fiscal_year Only for the given fiscal year
+    # @option opts [String] :statement_code Only of the given statement code
+    # @option opts [String] :type Only of the given type
+    # @option opts [String] :fiscal_period The fiscal period
+    # @option opts [Date] :start_date Only include fundamentals where covered period is on or after this date.
+    # @option opts [Date] :end_date Only include fundamentals where covered period is on or before this date.
+    # @option opts [String] :next_page Gets the next page of data from a previous API call
+    # @return [Array<(Fundamental, Fixnum, Hash)>] Fundamental data, response status code and response headers
+    def filter_fundamental_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FundamentalsApi.filter_fundamental ..."
+      end
+      if @api_client.config.client_side_validation && opts[:'statement_code'] && !['income_statement', 'balance_sheet_statement', 'cash_flow_statement', 'calculations'].include?(opts[:'statement_code'])
+        fail ArgumentError, 'invalid value for "statement_code", must be one of income_statement, balance_sheet_statement, cash_flow_statement, calculations'
+      end
+      if @api_client.config.client_side_validation && opts[:'type'] && !['QTR', 'YTD', 'FY', 'TTM'].include?(opts[:'type'])
+        fail ArgumentError, 'invalid value for "type", must be one of QTR, YTD, FY, TTM'
+      end
+      if @api_client.config.client_side_validation && opts[:'fiscal_period'] && !['Q1TTM', 'Q2TTM', 'Q3TTM', 'FY', 'Q1', 'Q2', 'Q3', 'Q4', 'Q2YTD', 'Q3YTD'].include?(opts[:'fiscal_period'])
+        fail ArgumentError, 'invalid value for "fiscal_period", must be one of Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD'
+      end
+      # resource path
+      local_var_path = "/fundamentals"
+
+      # query parameters
+      query_params = {}
+      query_params[:'filed_after'] = opts[:'filed_after'] if !opts[:'filed_after'].nil?
+      query_params[:'filed_before'] = opts[:'filed_before'] if !opts[:'filed_before'].nil?
+      query_params[:'reported_only'] = opts[:'reported_only'] if !opts[:'reported_only'].nil?
+      query_params[:'fiscal_year'] = opts[:'fiscal_year'] if !opts[:'fiscal_year'].nil?
+      query_params[:'statement_code'] = opts[:'statement_code'] if !opts[:'statement_code'].nil?
+      query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+      query_params[:'fiscal_period'] = opts[:'fiscal_period'] if !opts[:'fiscal_period'].nil?
+      query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].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 => 'Fundamental')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FundamentalsApi#filter_fundamental\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Fundamental by ID
-    # Returns detailed fundamental data for the given `id`.
+    # Returns a specific fundamental associated with a particular unique fundamental ID. Useful for pulling reference data for a specific fundamental.
     # @param id The Intrinio ID for the Fundamental
     # @param [Hash] opts the optional parameters
     # @return [Fundamental]
@@ -31,7 +117,7 @@ module Intrinio
     end
 
     # Fundamental by ID
-    # Returns detailed fundamental data for the given &#x60;id&#x60;.
+    # Returns a specific fundamental associated with a particular unique fundamental ID. Useful for pulling reference data for a specific fundamental.
     # @param id The Intrinio ID for the Fundamental
     # @param [Hash] opts the optional parameters
     # @return [Array<(Fundamental, Fixnum, Hash)>] Fundamental data, response status code and response headers
@@ -74,7 +160,7 @@ module Intrinio
     end
 
     # Reported Financials
-    # Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company
+    # Returns as-reported financial statement data for income statement, balance sheet, and cash flow statement. Data for income statement and cash flow statement is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.
     # @param id The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
     # @param [Hash] opts the optional parameters
     # @return [ApiResponseReportedFinancials]
@@ -84,7 +170,7 @@ module Intrinio
     end
 
     # Reported Financials
-    # Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company
+    # Returns as-reported financial statement data for income statement, balance sheet, and cash flow statement. Data for income statement and cash flow statement is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.
     # @param id The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
     # @param [Hash] opts the optional parameters
     # @return [Array<(ApiResponseReportedFinancials, Fixnum, Hash)>] ApiResponseReportedFinancials data, response status code and response headers
@@ -127,7 +213,7 @@ module Intrinio
     end
 
     # Standardized Financials
-    # Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies' fundamentals.
+    # Returns standardized financial statement data for income statement, balance sheet, cash flow statement and over 100 associated calculations for a given company. Data for income statement, cash flow statement, and calculations is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.
     # @param id The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
     # @param [Hash] opts the optional parameters
     # @return [ApiResponseStandardizedFinancials]
@@ -137,7 +223,7 @@ module Intrinio
     end
 
     # Standardized Financials
-    # Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies&#39; fundamentals.
+    # Returns standardized financial statement data for income statement, balance sheet, cash flow statement and over 100 associated calculations for a given company. Data for income statement, cash flow statement, and calculations is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.
     # @param id The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
     # @param [Hash] opts the optional parameters
     # @return [Array<(ApiResponseStandardizedFinancials, Fixnum, Hash)>] ApiResponseStandardizedFinancials data, response status code and response headers
@@ -239,7 +325,7 @@ module Intrinio
     end
 
     # Lookup Fundamental
-    # Returns the Fundamental for the Company with the given `identifier` and with the given parameters
+    # Returns a specific fundamental with unique fundamental ID associated with a particular company, year, period and statement. Useful for pulling the unique fundamental ID and reference data for a specific fundamental.
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param statement_code The statement code
     # @param fiscal_year The fiscal year
@@ -252,7 +338,7 @@ module Intrinio
     end
 
     # Lookup Fundamental
-    # Returns the Fundamental for the Company with the given &#x60;identifier&#x60; and with the given parameters
+    # Returns a specific fundamental with unique fundamental ID associated with a particular company, year, period and statement. Useful for pulling the unique fundamental ID and reference data for a specific fundamental.
     # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @param statement_code The statement code
     # @param fiscal_year The fiscal year

data/lib/intrinio-sdk/api/historical_data_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.29.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/index_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.29.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -21,7 +21,7 @@ module Intrinio
     end
 
     # All Economic Indices
-    # 
+    # Returns a list of reference data on more than 200,000 economic indices from the Federal Reserve Economic Data (FRED) database.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size The number of results to return (default to 100)
     # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -32,7 +32,7 @@ module Intrinio
     end
 
     # All Economic Indices
-    # 
+    # Returns a list of reference data on more than 200,000 economic indices from the Federal Reserve Economic Data (FRED) database.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size The number of results to return
     # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -192,7 +192,7 @@ module Intrinio
     end
 
     # Lookup Economic Index
-    # 
+    # Returns reference data for a specified Federal Reserve Economic Data (FRED) series ID.
     # @param identifier An Index Identifier (symbol, Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @return [EconomicIndex]
@@ -202,7 +202,7 @@ module Intrinio
     end
 
     # Lookup Economic Index
-    # 
+    # Returns reference data for a specified Federal Reserve Economic Data (FRED) series ID.
     # @param identifier An Index Identifier (symbol, Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @return [Array<(EconomicIndex, Fixnum, Hash)>] EconomicIndex data, response status code and response headers
@@ -245,7 +245,7 @@ module Intrinio
     end
 
     # Data Point (Number) for an Economic Index
-    # Returns a numeric value for the given `tag` for the Economic Index with the given `identifier`
+    # Returns latest data for a specified Federal Reserve Economic Data (FRED) ID.
     # @param identifier An Index Identifier (symbol, Intrinio ID)
     # @param tag An Intrinio data tag &lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a&gt;
     # @param [Hash] opts the optional parameters
@@ -256,7 +256,7 @@ module Intrinio
     end
 
     # Data Point (Number) for an Economic Index
-    # Returns a numeric value for the given &#x60;tag&#x60; for the Economic Index with the given &#x60;identifier&#x60;
+    # Returns latest data for a specified Federal Reserve Economic Data (FRED) ID.
     # @param identifier An Index Identifier (symbol, Intrinio ID)
     # @param tag An Intrinio data tag &lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a&gt;
     # @param [Hash] opts the optional parameters
@@ -363,7 +363,7 @@ module Intrinio
     end
 
     # Historical Data for an Economic Index
-    # Returns historical values for the given `tag` and the Economic Index with the given `identifier`
+    # Returns historical data for a specified Federal Reserve Economic Data (FRED) ID over a period of time.
     # @param identifier An Index Identifier (symbol, Intrinio ID)
     # @param tag An Intrinio data tag &lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a&gt;
     # @param [Hash] opts the optional parameters
@@ -380,7 +380,7 @@ module Intrinio
     end
 
     # Historical Data for an Economic Index
-    # Returns historical values for the given &#x60;tag&#x60; and the Economic Index with the given &#x60;identifier&#x60;
+    # Returns historical data for a specified Federal Reserve Economic Data (FRED) ID over a period of time.
     # @param identifier An Index Identifier (symbol, Intrinio ID)
     # @param tag An Intrinio data tag &lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a&gt;
     # @param [Hash] opts the optional parameters
@@ -957,7 +957,7 @@ module Intrinio
     end
 
     # Search Economic Indices
-    # Searches for indices using the text in `query`
+    # Search the Federal Reserve Economic Data (FRED) database and return a list of economic indices matching the text query parameter passed through.
     # @param query Search query
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size The number of results to return (default to 100)
@@ -968,7 +968,7 @@ module Intrinio
     end
 
     # Search Economic Indices
-    # Searches for indices using the text in &#x60;query&#x60;
+    # Search the Federal Reserve Economic Data (FRED) database and return a list of economic indices matching the text query parameter passed through.
     # @param query Search query
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size The number of results to return

data/lib/intrinio-sdk/api/insider_transaction_filings_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.29.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/municipality_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.29.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

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.29.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.
@@ -924,8 +927,64 @@ module Intrinio
       return data, status_code, headers
     end
 
+    # Option Prices Realtime Snapshot
+    # Returns all options snapshots for the queried interval with links to download.
+    # @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.
+    # @return [OptionSnapshotsResult]
+    def get_options_snapshots(opts = {})
+      data, _status_code, _headers = get_options_snapshots_with_http_info(opts)
+      return data
+    end
+
+    # Option Prices Realtime Snapshot
+    # Returns all options snapshots for the queried interval with links to download.
+    # @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.
+    # @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
+        @api_client.config.logger.debug "Calling API: OptionsApi.get_options_snapshots ..."
+      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/snapshots"
+
+      # query parameters
+      query_params = {}
+      query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
+      query_params[:'at_datetime'] = opts[:'at_datetime'] if !opts[:'at_datetime'].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 => 'OptionSnapshotsResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OptionsApi#get_options_snapshots\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    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 +995,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 +1043,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 +1054,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 +1189,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 +1199,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.29.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 = {})