intrinio-sdk 5.6.3 → 5.6.4

data/lib/intrinio-sdk/api/bulk_downloads_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://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.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/company_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://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.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -870,6 +870,7 @@ module Intrinio
     # Searches for Companies matching the text `query`
     # @param query Search parameters
     # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :active When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.
     # @option opts [Integer] :page_size The number of results to return (default to 100)
     # @return [ApiResponseCompaniesSearch]
     def search_companies(query, opts = {})
@@ -881,6 +882,7 @@ module Intrinio
     # Searches for Companies matching the text `query`
     # @param query Search parameters
     # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :active When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.
     # @option opts [Integer] :page_size The number of results to return
     # @return [Array<(ApiResponseCompaniesSearch, Fixnum, Hash)>] ApiResponseCompaniesSearch data, response status code and response headers
     def search_companies_with_http_info(query, opts = {})
@@ -901,6 +903,7 @@ module Intrinio
       # query parameters
       query_params = {}
       query_params[:'query'] = query
+      query_params[:'active'] = opts[:'active'] if !opts[:'active'].nil?
       query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
 
       # header parameters

data/lib/intrinio-sdk/api/data_point_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://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.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/data_tag_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://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.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/et_fs_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://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.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/filing_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://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.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/forex_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://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.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

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

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://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.15.3
+OpenAPI spec version: 2.16.4
 
 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://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.15.3
+OpenAPI spec version: 2.16.4
 
 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://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.15.3
+OpenAPI spec version: 2.16.4
 
 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://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.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -197,6 +197,104 @@ module Intrinio
       return data, status_code, headers
     end
 
+    # Options Chain Realtime
+    # Returns all realtime options contracts and their prices for the given symbol and expiration date.
+    # @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.
+    # @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 [Float] :volume_greater_than The volume of the option contract. This will return options contracts with volumes greater than this amount.
+    # @option opts [Float] :volume_less_than The volume of the option contract. This will return options contracts with volumes less than this amout.
+    # @option opts [Float] :open_interest_greater_than The open interest of the option contract. This will return options contracts with open interest greater than this amount.
+    # @option opts [Float] :open_interest_less_than The open interest of the option contract. This will return options contracts with open interest less than this amount.
+    # @option opts [String] :moneyness The moneyness of the options contracts to return. 'all' will return all options contracts. 'in_the_money' will return options contracts that are in the money (call options with strike prices below the current price, put options with strike prices above the current price). 'out_of_they_money' will return options contracts that are out of the money (call options with strike prices above the current price, put options with strike prices below the current price). 'near_the_money' will return options contracts that are $0.50 or less away from being in the money.  Requires subscription to realtime stock price data.
+    # @return [ApiResponseOptionsChainRealtime]
+    def get_options_chain_realtime(symbol, expiration, opts = {})
+      data, _status_code, _headers = get_options_chain_realtime_with_http_info(symbol, expiration, opts)
+      return data
+    end
+
+    # Options Chain Realtime
+    # Returns all realtime options contracts and their prices for the given symbol and expiration date.
+    # @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.
+    # @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 [Float] :volume_greater_than The volume of the option contract. This will return options contracts with volumes greater than this amount.
+    # @option opts [Float] :volume_less_than The volume of the option contract. This will return options contracts with volumes less than this amout.
+    # @option opts [Float] :open_interest_greater_than The open interest of the option contract. This will return options contracts with open interest greater than this amount.
+    # @option opts [Float] :open_interest_less_than The open interest of the option contract. This will return options contracts with open interest less than this amount.
+    # @option opts [String] :moneyness The moneyness of the options contracts to return. 'all' will return all options contracts. 'in_the_money' will return options contracts that are in the money (call options with strike prices below the current price, put options with strike prices above the current price). 'out_of_they_money' will return options contracts that are out of the money (call options with strike prices above the current price, put options with strike prices below the current price). 'near_the_money' will return options contracts that are $0.50 or less away from being in the money.  Requires subscription to realtime stock price data.
+    # @return [Array<(ApiResponseOptionsChainRealtime, Fixnum, Hash)>] ApiResponseOptionsChainRealtime data, response status code and response headers
+    def get_options_chain_realtime_with_http_info(symbol, expiration, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OptionsApi.get_options_chain_realtime ..."
+      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_chain_realtime"
+      end
+      # verify the required parameter 'expiration' is set
+      if @api_client.config.client_side_validation && expiration.nil?
+        fail ArgumentError, "Missing the required parameter 'expiration' when calling OptionsApi.get_options_chain_realtime"
+      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[:'type'] && !['call', 'put'].include?(opts[:'type'])
+        fail ArgumentError, 'invalid value for "type", must be one of call, put'
+      end
+      if @api_client.config.client_side_validation && opts[:'moneyness'] && !['all', 'in_the_money', 'out_of_the_money', 'near_the_money'].include?(opts[:'moneyness'])
+        fail ArgumentError, 'invalid value for "moneyness", must be one of all, in_the_money, out_of_the_money, near_the_money'
+      end
+      # resource path
+      local_var_path = "/options/chain/{symbol}/{expiration}/realtime".sub('{' + 'symbol' + '}', symbol.to_s).sub('{' + 'expiration' + '}', expiration.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
+      query_params[:'type'] = opts[:'type'] if !opts[:'type'].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[:'volume_greater_than'] = opts[:'volume_greater_than'] if !opts[:'volume_greater_than'].nil?
+      query_params[:'volume_less_than'] = opts[:'volume_less_than'] if !opts[:'volume_less_than'].nil?
+      query_params[:'open_interest_greater_than'] = opts[:'open_interest_greater_than'] if !opts[:'open_interest_greater_than'].nil?
+      query_params[:'open_interest_less_than'] = opts[:'open_interest_less_than'] if !opts[:'open_interest_less_than'].nil?
+      query_params[:'moneyness'] = opts[:'moneyness'] if !opts[:'moneyness'].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 => 'ApiResponseOptionsChainRealtime')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OptionsApi#get_options_chain_realtime\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Options Expirations
     # Returns all option contract expiration dates for a given symbol.
     # @param symbol The option symbol, corresponding to the underlying security.
@@ -324,5 +422,64 @@ module Intrinio
       end
       return data, status_code, headers
     end
+
+    # Option Prices Realtime
+    # Returns all option prices for a given option contract identifier.
+    # @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 [ApiResponseOptionPricesRealtime]
+    def get_options_prices_realtime(identifier, opts = {})
+      data, _status_code, _headers = get_options_prices_realtime_with_http_info(identifier, opts)
+      return data
+    end
+
+    # Option Prices Realtime
+    # Returns all option prices for a given option contract identifier.
+    # @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 [Array<(ApiResponseOptionPricesRealtime, Fixnum, Hash)>] ApiResponseOptionPricesRealtime data, response status code and response headers
+    def get_options_prices_realtime_with_http_info(identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OptionsApi.get_options_prices_realtime ..."
+      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.get_options_prices_realtime"
+      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/prices/{identifier}/realtime".sub('{' + 'identifier' + '}', identifier.to_s)
+
+      # query parameters
+      query_params = {}
+      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 => 'ApiResponseOptionPricesRealtime')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OptionsApi#get_options_prices_realtime\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/intrinio-sdk/api/security_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://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.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -3579,9 +3579,9 @@ module Intrinio
     end
 
     # Screen Securities
-    # Screen Securities using complex logic
+    # Screen Securities using complex logic. Use POST only. See <a href=\"https://docs.intrinio.com/documentation/screener_v2\" target=\"_blank\">screener documentation</a> for details on how to construct conditions.
     # @param [Hash] opts the optional parameters
-    # @option opts [SecurityScreenGroup] :logic The logic to screen with, consisting of operators, clauses, and nested groups.&lt;br/&gt; See &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.
+    # @option opts [SecurityScreenGroup] :logic The logic to screen with, consisting of operators, clauses, and nested groups. &lt;/br&gt; See &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.
     # @option opts [String] :order_column Results returned sorted by this column
     # @option opts [String] :order_direction Sort order to use with the order_column (default to asc)
     # @option opts [BOOLEAN] :primary_only Return only primary securities (default to false)
@@ -3593,9 +3593,9 @@ module Intrinio
     end
 
     # Screen Securities
-    # Screen Securities using complex logic
+    # Screen Securities using complex logic. Use POST only. See &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.
     # @param [Hash] opts the optional parameters
-    # @option opts [SecurityScreenGroup] :logic The logic to screen with, consisting of operators, clauses, and nested groups.&lt;br/&gt; See &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.
+    # @option opts [SecurityScreenGroup] :logic The logic to screen with, consisting of operators, clauses, and nested groups. &lt;/br&gt; See &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.
     # @option opts [String] :order_column Results returned sorted by this column
     # @option opts [String] :order_direction Sort order to use with the order_column
     # @option opts [BOOLEAN] :primary_only Return only primary securities

data/lib/intrinio-sdk/api/stock_exchange_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://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.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/technical_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://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.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/zacks_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://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.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api_client.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://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.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -20,6 +20,9 @@ require 'retriable'
 
 module Intrinio
   class ApiClient
+    # The max number of seconds allowed between each retry interval
+    MAX_INTERVAL_SECONDS = 60
+    
     # The Configuration object holding settings to be used in the API client.
     attr_accessor :config
 
@@ -48,13 +51,16 @@ module Intrinio
     # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
     #   the data deserialized from response body (could be nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
+      non_retriable_error = nil
       retry_amount = @config.allow_retries ? 5 : 1
-      Retriable.retriable(tries: retry_amount, base_interval: 1.0, multiplier: 1.0, rand_factor: 0.5) do
+      Retriable.retriable(tries: retry_amount, base_interval: 1.0, multiplier: 1.0, rand_factor: 0.5, max_interval: MAX_INTERVAL_SECONDS) do
         @config.logger.debug("Calling Intrinio API [#{http_method}] - #{path}...") if @config.debugging
         
         request = build_request(http_method, path, opts)
         response = request.run
-      
+        
+        rate_limit_header = response.headers["retry-after"]
+        
         if @config.debugging
           @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
         end
@@ -62,6 +68,23 @@ module Intrinio
         unless response.success?
           if response.timed_out?
             fail ApiError.new('Connection timed out')
+          elsif response.code == 429 && rate_limit_header
+            wait_in_seconds = rate_limit_header.to_i
+            
+            #if the rate limit elapse time header is less than the max allowed interval time, sleep the program until the rate limit period elapses
+            if wait_in_seconds < MAX_INTERVAL_SECONDS
+              @config.logger.debug "API Rate Limit Reached - Retrying in #{wait_in_seconds} seconds..."
+              sleep(wait_in_seconds)
+            end
+            
+            fail ApiError.new(:code => 429,
+                              :message => response.return_message)
+          elsif response.code.to_s.split("")[0].to_i == 4
+            # Do not retry any other 400 errors, break the retry block
+            non_retriable_error = ApiError.new(:code => response.code,
+                              :response_headers => response.headers,
+                              :response_body => response.body)
+            break
           elsif response.code == 0
             # Errors from libcurl will be made visible here
             fail ApiError.new(:code => 0,
@@ -81,6 +104,9 @@ module Intrinio
         end
         return data, response.code, response.headers
       end
+      
+      # Catch errors that broke out of retry block
+      fail non_retriable_error
     end
 
     # Builds the HTTP request

data/lib/intrinio-sdk/api_error.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://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.15.3
+OpenAPI spec version: 2.16.4
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset