Added parameters to technical indicator API

Author: Nawado-gg

eodhd/APIs/TechnicalIndicatorAPI.py

@@ -10,7 +10,10 @@ class TechnicalIndicatorAPI(BaseAPI):
 
     def get_technical_indicator_data(self, api_token: str, ticker: str, function: str, period: int = 50,
                                      date_from: str = None, date_to: str = None, order: str = 'a', 
-                                     splitadjusted_only: str = '0'):
+                                     splitadjusted_only: str = '0', agg_period = None,
+                                     fast_kperiod = None, slow_kperiod = None, slow_dperiod = None,
+                                     fast_dperiod = None, fast_period = None, slow_period = None,
+                                     signal_period = None, acceleration = None, maximum = None):
         endpoint = 'technical/'
 
         if ticker.strip() == "" or ticker is None:
@@ -29,6 +32,41 @@ def get_technical_indicator_data(self, api_token: str, ticker: str, function: st
         if date_from is not None:
             query_string += "&from=" + date_from
 
+        if function == 'splitadjusted':
+            possible_agg_period = ['d', 'w', 'm']
+            if agg_period is not None:
+                if agg_period not in possible_agg_period:
+                    raise ValueError("agg_period must be in ['d', 'w', 'm']")
+                query_string += "&agg_period=" + agg_period
+
+        if function == 'stochastic':
+            if fast_kperiod is not None:
+                query_string += "&fast_kperiod=" + fast_kperiod
+            if slow_kperiod is not None:
+                query_string += "&slow_kperiod=" + slow_kperiod
+            if slow_dperiod is not None:
+                query_string += "&slow_dperiod=" + slow_dperiod
+
+        if function == 'stochrsi':
+            if fast_kperiod is not None:
+                query_string += "&fast_kperiod=" + fast_kperiod
+            if fast_dperiod is not None:
+                query_string += "&fast_dperiod=" + fast_dperiod
+        
+        if function == 'macd':
+            if fast_period is not None:
+                query_string += "&fast_period=" + fast_period
+            if slow_period is not None:
+                query_string += "&slow_period=" + slow_period
+            if signal_period is not None:
+                query_string += "&signal_period=" + signal_period
+
+        if function == 'sar':
+            if acceleration is not None:
+                query_string += "&acceleration=" + acceleration
+            if maximum is not None:
+                query_string += "&maximum=" + maximum 
+
         return self._rest_get_method(api_key = api_token, endpoint = endpoint, uri = ticker, querystring = query_string)
 
 

eodhd/apiclient.py

@@ -454,6 +454,16 @@ def get_technical_indicator_data(
         date_to: str = None,
         order: str = "a",
         splitadjusted_only: str = "0",
+        agg_period: str = None,
+        fast_kperiod: int = None,
+        slow_kperiod: int = None,
+        slow_dperiod: int = None,
+        fast_dperiod: int = None,
+        fast_period: int = None,
+        slow_period: int = None,
+        signal_period: int = None,
+        acceleration: float = None,
+        maximum: float = None
     ) -> list:
         """Available args:
         ticker (required) - consists of two parts: [SYMBOL_NAME].[EXCHANGE_ID]. Example: AAPL.US
@@ -464,16 +474,35 @@ def get_technical_indicator_data(
                                     'cci', 'sar', 'bbands', 'format_amibroker', 'splitadjusted']
             Description for possible functions you get here:
             https://eodhistoricaldata.com/financial-apis/technical-indicators-api/
-        period – the number of data points used to calculate each moving average value.
-            Valid range from 2 to 100000 with the default value – 50.
+        period - the number of data points used to calculate each moving average value.
+            Valid range from 2 to 100000 with the default value - 50.
         date_from (not required) - date from with format Y-m-d. Example: 2000-01-01
         date_to (not required) - date from with format Y-m-d. Example: 2000-01-01
-        order – use ‘a’ for ascending dates (from old to new) and ‘d’ for descending dates (from new to old).
+        order - use 'a' for ascending dates (from old to new) and 'd' for descending dates (from new to old).
             By default, dates are shown in ascending order.
-        splitadjusted_only – default value is ‘0’.
+        splitadjusted_only - default value is '0'.
             By default, we calculate data for some functions by closes adjusted with splits and dividends.
-            If you need to calculate the data by closes adjusted only with splits, set this parameter to ‘1’.
+            If you need to calculate the data by closes adjusted only with splits, set this parameter to '1'.
             Works with the following functions: sma, ema, wma, volatility, rsi, slope, and macd.
+
+        For some functions can be used additional parameters:
+        1. For splitadjusted:
+            agg_period [optional] – aggregation period. Default value – 'd'. Possible values: d – daily, w – weekly, m – monthly.
+        2. For stochastic:
+            fast_kperiod [optional] – Fast K-period, the default value is 14. Valid range from 2 to 100000.
+            slow_kperiod [optional] – Slow K-period, the default value is 3. Valid range from 2 to 100000.
+            slow_dperiod [optional] – Slow D-period, the default value is 3. Valid range from 2 to 100000.
+        3. For stochrsi:
+            fast_kperiod [optional] – Fast K-period, the default value is 14. Valid range from 2 to 100000.
+            fast_dperiod [optional] – Fast D-period, the default value is 14. Valid range from 2 to 100000.
+        4. For macd:
+            fast_period [optional] – the default value is 12. Valid range from 2 to 100000.
+            slow_period [optional] – the default value is 26. Valid range from 2 to 100000.
+            signal_period [optional] – the default value is 9. Valid range from 2 to 100000.
+        5. For sar:
+            acceleration [optional] – Acceleration Factor used up to the Maximum value. Default value – 0.02.
+            maximum [optional] – Acceleration Factor Maximum value. Default value – 0.20.
+        For those functions use this parameters to set periods.
         """
 
         api_call = TechnicalIndicatorAPI()
@@ -486,6 +515,16 @@ def get_technical_indicator_data(
             date_to=date_to,
             order=order,
             splitadjusted_only=splitadjusted_only,
+            agg_period=agg_period,
+            fast_kperiod=fast_kperiod,
+            slow_kperiod=slow_kperiod,
+            slow_dperiod=slow_dperiod,
+            fast_dperiod=fast_dperiod,
+            fast_period=fast_period,
+            slow_period=slow_period,
+            signal_period=signal_period,
+            acceleration=acceleration,
+            maximum=maximum
         )
 
     def get_live_stock_prices(self, ticker, date_to=None, date_from=None, s=None) -> list: