Merge pull request #271 from psdupvi/master

Add Lactate Threshold endpoints

Author: cyberjunky

example.py

@@ -42,6 +42,7 @@
 # Let's say we want to scrape all activities using switch menu_option "p". We change the values of the below variables, IE startdate days, limit,...
 today = datetime.date.today()
 startdate = today - datetime.timedelta(days=7)  # Select past week
+startdate_four_weeks = today - datetime.timedelta(days=28)
 start = 0
 limit = 100
 start_badge = 1  # Badge related calls calls start counting at 1
@@ -141,6 +142,7 @@
     "U": f"Get Fitness Age data for {today.isoformat()}",
     "V": f"Get daily wellness events data for {startdate.isoformat()}",
     "W": "Get userprofile settings",
+    "X": "Get lactate threshold data, both Latest and for the past four weeks",
     "Z": "Remove stored login tokens (logout)",
     "q": "Exit",
 }
@@ -908,6 +910,14 @@ def switch(api, i):
                     "api.get_userprofile_settings()", api.get_userprofile_settings()
                 )
 
+            elif i == "X":
+                # Get latest lactate threshold
+                display_json(
+                    "api.get_lactate_threshold(latest=True)", api.get_lactate_threshold(latest=True)
+                )
+                # Get historical lactate threshold for past four weeks
+                display_json(f"api.get_lactate_threshold(latest=False, start_date='{startdate_four_weeks.isoformat()}', end_date='{today.isoformat()}', aggregation='daily')", api.get_lactate_threshold(latest=False, start_date=startdate_four_weeks.isoformat(),
+                                              end_date=today.isoformat(), aggregation="daily"),                )
             elif i == "Z":
                 # Remove stored login tokens for Garmin Connect portal
                 tokendir = os.path.expanduser(tokenstore)

garminconnect/__init__.py

@@ -54,6 +54,13 @@ def __init__(
         self.garmin_connect_metrics_url = (
             "/metrics-service/metrics/maxmet/daily"
         )
+        self.garmin_connect_biometric_url = (
+            "/biometric-service/biometric"
+        )
+
+        self.garmin_connect_biometric_stats_url = (
+            "/biometric-service/stats"
+        )
         self.garmin_connect_daily_hydration_url = (
             "/usersummary-service/usersummary/hydration/daily"
         )
@@ -618,6 +625,88 @@ def get_max_metrics(self, cdate: str) -> Dict[str, Any]:
 
         return self.connectapi(url)
 
+    def get_lactate_threshold(self, *,latest: bool=True, start_date: Optional[str|date]=None, end_date: Optional[str|date]=None, aggregation: str ="daily") -> Dict:
+        """
+        Returns Running Lactate Threshold information, including heart rate, power, and speed
+
+        :param bool required - latest: Whether to query for the latest Lactate Threshold info or a range.  False if querying a range
+        :param date optional - start_date: The first date in the range to query, format 'YYYY-MM-DD'.  Required if `latest` is False.  Ignored if `latest` is True
+        :param date optional - end_date: The last date in the range to query, format 'YYYY-MM-DD'. Defaults to current data. Ignored if `latest` is True
+        :param str optional - aggregation: How to aggregate the data. Must be one of `daily`, `weekly`, `monthly`, `yearly`.
+
+        """
+
+        if latest:
+
+            speed_and_heart_rate_url = f"{self.garmin_connect_biometric_url}/latestLactateThreshold"
+            power_url = f"{self.garmin_connect_biometric_url}/powerToWeight/latest/{date.today()}?sport=Running"
+
+            power = self.connectapi(power_url)
+            try:
+                power_dict = power[0]
+            except IndexError:
+                # If no power available
+                power_dict = {}
+
+            speed_and_heart_rate = self.connectapi(speed_and_heart_rate_url)
+
+            speed_and_heart_rate_dict = {
+                "userProfilePK": None,
+                "version": None,
+                "calendarDate": None,
+                "sequence": None,
+                "speed": None,
+                "heartRate": None,
+                "heartRateCycling": None
+            }
+
+            # Garmin /latestLactateThreshold endpoint returns a list of two
+            # (or more, if cyclingHeartRate ever gets values) nearly identical dicts.
+            # We're combining them here
+            for entry in speed_and_heart_rate:
+                if entry['speed'] is not None:
+                    speed_and_heart_rate_dict["userProfilePK"] = entry["userProfilePK"]
+                    speed_and_heart_rate_dict["version"] = entry["version"]
+                    speed_and_heart_rate_dict["calendarDate"] = entry["calendarDate"]
+                    speed_and_heart_rate_dict["sequence"] = entry["sequence"]
+                    speed_and_heart_rate_dict["speed"] = entry["speed"]
+
+                # This is not a typo. The Garmin dictionary has a typo as of 2025-07-08, refering to it as "hearRate"
+                elif entry['hearRate'] is not None:
+                    speed_and_heart_rate_dict["heartRate"] = entry["hearRate"] # Fix Garmin's typo
+
+                # Doesn't exist for me but adding it just in case.  We'll check for each entry
+                if entry['heartRateCycling'] is not None:
+                    speed_and_heart_rate_dict["heartRateCycling"] = entry["heartRateCycling"]
+
+            return {
+                "speed_and_heart_rate": speed_and_heart_rate_dict,
+                "power": power_dict
+            }
+
+
+        if start_date is None:
+            raise ValueError("You must either specify 'latest=True' or a start_date")
+
+        if end_date is None:
+            end_date = date.today().isoformat()
+
+        _valid_aggregations = {"daily", "weekly", "monthly", "yearly"}
+        if aggregation not in _valid_aggregations:
+            raise ValueError(f"aggregation must be one of {_valid_aggregations}")
+
+        speed_url = f"{self.garmin_connect_biometric_stats_url}/lactateThresholdSpeed/range/{start_date}/{end_date}?sport=RUNNING&aggregation={aggregation}&aggregationStrategy=LATEST"
+
+        heart_rate_url = f"{self.garmin_connect_biometric_stats_url}/lactateThresholdHeartRate/range/{start_date}/{end_date}?sport=RUNNING&aggregation={aggregation}&aggregationStrategy=LATEST"
+
+        power_url = f"{self.garmin_connect_biometric_stats_url}/functionalThresholdPower/range/{start_date}/{end_date}?sport=RUNNING&aggregation={aggregation}&aggregationStrategy=LATEST"
+
+        speed = self.connectapi(speed_url)
+        heart_rate = self.connectapi(heart_rate_url)
+        power = self.connectapi(power_url)
+
+        return {"speed": speed, "heart_rate": heart_rate, "power": power}
+
     def add_hydration_data(
         self, value_in_ml: float, timestamp=None, cdate: Optional[str] = None
     ) -> Dict[str, Any]: