HRV extraction

[Soulnight-Geo]

Hi,

first thanks a lot for your work and script.
Works flawlessly for most f the parameters.

However, I did not success in exporting HRV.
After some different attempt I wrote this code but it exported everything except hrv.

Could you please tell me how to proceed?
Thanks a lot!
Happy new years,
Florian

#!/usr/bin/env python3

import os
import csv
import time
from datetime import date, timedelta
from getpass import getpass

import garminconnect
import requests

------------------ CONFIG -------------------

GARTH_HOME = os.getenv("GARTH_HOME", "~/.garth")
USERNAME = os.getenv("GARMIN_USERNAME", "")
PASSWORD = os.getenv("GARMIN_PASSWORD", "")

START_DATE = date(2022, 10, 15)
END_DATE = date(2022, 10, 16) # inclusive

DAILY_DATA_CSV = "daily_data.csv"
HRV_READINGS_CSV = "hrv_readings.csv"

SLEEP_SECONDS = 0.0

---------------------------------------------

def get_hrv(session: requests.Session, date_str: str):
"""Manual fetch of HRV from private Garmin endpoint."""
url = f"https://connectapi.garmin.com/hrv-service/hrv/{date_str}"
try:
r = session.get(url, timeout=10)
if r.status_code == 200:
return r.json()
else:
print(f" -> get_hrv({date_str}): {r.status_code}")
except Exception as e:
print(f" -> get_hrv({date_str}) error: {e}")
return {}

def main():
# 1) Prompt for creds if not set
global USERNAME, PASSWORD
if not USERNAME:
USERNAME = input("Garmin email: ")
if not PASSWORD:
PASSWORD = getpass("Garmin password: ")

# 2) Log in with Garth
print(f"Logging into Garmin Connect as {USERNAME}...")
garmin = garminconnect.Garmin(USERNAME, PASSWORD)
garmin.login()
print("Login successful!")

print(f"Saving session tokens to {GARTH_HOME}...")
garmin.garth.dump(GARTH_HOME)

# 3) Attempt to find an internal session on garmin.garth
session = None
if hasattr(garmin.garth, "session"):
    session = garmin.garth.session
elif hasattr(garmin.garth, "_session"):
    session = garmin.garth._session
elif hasattr(garmin.garth, "http"):
    maybe_sess = garmin.garth.http
    if isinstance(maybe_sess, requests.Session):
        session = maybe_sess

have_session_for_hrv = bool(session)
if not have_session_for_hrv:
    print("WARNING: No session attribute found in garmin.garth.")
    print("         Will skip HRV calls and only retrieve built-in data.\n")

# 4) CSV setup
daily_headers = [
    "date",
    "totalSteps", "restingHeartRate",
    "minHeartRate", "maxHeartRate",
    "floorsAscended", "floorsDescended",
    "totalKilocalories", "activeKilocalories", "bmrKilocalories",
    "weight", "bodyFat",
    # HRV summary fields (if we can fetch them)
    "hrv_weeklyAvg", "hrv_lastNightAvg", "hrv_lastNight5MinHigh",
    "hrv_baseline_lowUpper", "hrv_baseline_balancedLow",
    "hrv_baseline_balancedUpper", "hrv_baseline_markerValue",
    "hrv_status", "hrv_feedbackPhrase",
]
hrv_headers = [
    "date", "readingTimeLocal", "readingTimeGMT", "hrvValue"
]

with open(DAILY_DATA_CSV, "w", newline="", encoding="utf-8") as daily_f, \
     open(HRV_READINGS_CSV, "w", newline="", encoding="utf-8") as hrv_f:

    daily_writer = csv.DictWriter(daily_f, fieldnames=daily_headers)
    hrv_writer   = csv.DictWriter(hrv_f,   fieldnames=hrv_headers)

    daily_writer.writeheader()
    hrv_writer.writeheader()

    # 5) Loop over date range
    current = START_DATE
    while current <= END_DATE:
        day_str = current.isoformat()
        print(f"\n=== Data for {day_str} ===")

        # A) Built-in stats from Garth
        stats_and_body = garmin.get_stats_and_body(day_str)

        row = {
            "date": day_str,
            "totalSteps":        stats_and_body.get("totalSteps"),
            "restingHeartRate":  stats_and_body.get("restingHeartRate"),
            "minHeartRate":      stats_and_body.get("minHeartRate"),
            "maxHeartRate":      stats_and_body.get("maxHeartRate"),
            "floorsAscended":    stats_and_body.get("floorsAscended"),
            "floorsDescended":   stats_and_body.get("floorsDescended"),
            "totalKilocalories": stats_and_body.get("totalKilocalories"),
            "activeKilocalories":stats_and_body.get("activeKilocalories"),
            "bmrKilocalories":   stats_and_body.get("bmrKilocalories"),
            "weight":            stats_and_body.get("weight"),
            "bodyFat":           stats_and_body.get("bodyFat"),
        }

        # B) If we do have a session, fetch HRV
        if have_session_for_hrv:
            hrv_data = get_hrv(session, day_str)
            hrv_summary  = hrv_data.get("hrvSummary", {})
            hrv_readings = hrv_data.get("hrvReadings", [])

            # Fill in summary fields
            row["hrv_weeklyAvg"]           = hrv_summary.get("weeklyAvg")
            row["hrv_lastNightAvg"]        = hrv_summary.get("lastNightAvg")
            row["hrv_lastNight5MinHigh"]   = hrv_summary.get("lastNight5MinHigh")
            row["hrv_baseline_lowUpper"]   = hrv_summary.get("baseline", {}).get("lowUpper")
            row["hrv_baseline_balancedLow"]  = hrv_summary.get("baseline", {}).get("balancedLow")
            row["hrv_baseline_balancedUpper"]= hrv_summary.get("baseline", {}).get("balancedUpper")
            row["hrv_baseline_markerValue"]  = hrv_summary.get("baseline", {}).get("markerValue")
            row["hrv_status"]              = hrv_summary.get("status")
            row["hrv_feedbackPhrase"]      = hrv_summary.get("feedbackPhrase")

            # Write out raw readings
            for reading in hrv_readings:
                hrv_writer.writerow({
                    "date": day_str,
                    "readingTimeLocal": reading.get("readingTimeLocal"),
                    "readingTimeGMT":   reading.get("readingTimeGMT"),
                    "hrvValue":         reading.get("hrvValue"),
                })

        # Write daily row
        daily_writer.writerow(row)

        current += timedelta(days=1)
        if SLEEP_SECONDS > 0:
            time.sleep(SLEEP_SECONDS)

print(f"\nDone!\n => Wrote daily data to: {DAILY_DATA_CSV}")
print(f" => Wrote HRV readings to: {HRV_READINGS_CSV}")

---

if name == "main":
main()

[Soulnight-Geo]

My bad, I just made i work, no need to spend time on this. I will share my code later for everyone else wondering the same.
Cheers!

[Soulnight-Geo]

Here is my full working script:

#!/usr/bin/env python3
import os
import csv
from datetime import date, timedelta
from getpass import getpass
import time

import garminconnect

------------------------------------------------------------------------

CONFIGURATION

------------------------------------------------------------------------

USERNAME = os.getenv("GARMIN_USERNAME", "") # or "[email protected]"
PASSWORD = os.getenv("GARMIN_PASSWORD", "")
GARTH_HOME = os.getenv("GARTH_HOME", "~/.garth")

Choose your date range

START_DATE = date(2022, 10, 15)
END_DATE = date.today() # Inclusive, set to today's date

Output CSV (one file)

DAILY_DATA_CSV = "daily_data.csv"

If you want to slow down requests (avoid rate-limits):

SLEEP_SECONDS = 2.0 # Sleep for 2 seconds between requests

------------------------------------------------------------------------

MAIN SCRIPT

------------------------------------------------------------------------

def main():
# 1) Prompt for credentials if not provided
global USERNAME, PASSWORD
if not USERNAME:
USERNAME = input("Garmin email: ")
if not PASSWORD:
PASSWORD = getpass("Garmin password: ")

# Expand GARTH_HOME path
global GARTH_HOME
GARTH_HOME = os.path.expanduser(GARTH_HOME)

# 2) Log in via Garth
print(f"Logging into Garmin Connect as {USERNAME}...")
client = garminconnect.Garmin(USERNAME, PASSWORD)
client.login()
print("Login successful!\n")

# If the library supports saving tokens, do so:
try:
    client.garth.dump(GARTH_HOME)
    print(f"Saved session tokens to {GARTH_HOME} ...\n")
except AttributeError:
    pass

# 3) Prepare CSV
#
# Single file with a wide range of daily metrics:
#   date, steps, restingHR, minHR, maxHR, total/active/bmr KCal,
#   weight, blood pressure, VO2 max, HRV daily summary
#
fieldnames = [
    "date",
    # Steps, RHR, etc.
    "totalSteps",
    "restingHeartRate",
    "minHeartRate",
    "maxHeartRate",
    "totalKilocalories",
    "activeKilocalories",
    "bmrKilocalories",
    # Weight
    "weight_kg",
    # Blood Pressure
    "bp_systolic",
    "bp_diastolic",
    # VO2 Max
    "vo2max",
    # HRV summary (no full overnight curve)
    "hrv_weeklyAvg",
    "hrv_lastNightAvg",
    "hrv_lastNight5MinHigh",
    "hrv_baseline_lowUpper",
    "hrv_baseline_balancedLow",
    "hrv_baseline_balancedUpper",
    "hrv_baseline_markerValue",
    "hrv_status",
    "hrv_feedbackPhrase",
]

with open(DAILY_DATA_CSV, "w", newline="", encoding="utf-8") as csvfile:
    writer = csv.DictWriter(csvfile, fieldnames=fieldnames)
    writer.writeheader()

    # 4) Iterate over date range
    current_date = START_DATE
    while current_date <= END_DATE:
        date_str = current_date.isoformat()
        print(f"=== Retrieving data for {date_str} ===")

        # A) Get daily stats (steps, resting HR, etc.)
        daily_stats = {}
        try:
            daily_stats = client.get_stats_and_body(date_str)
        except AttributeError:
            print(
                "  -> `get_stats_and_body` not supported. Some daily data missing."
            )
        except Exception as e:
            print(f"  -> Error get_stats_and_body({date_str}): {e}")

        # B) Weight
        weight_kg = None
        try:
            body_comp = client.get_body_composition(date_str)
            date_list = body_comp.get("dateWeightList", [])
            if date_list:
                weight_kg = date_list[0].get("weight")
        except AttributeError:
            print("  -> `get_body_composition` not supported.")
        except Exception as e:
            print(f"  -> Error get_body_composition({date_str}): {e}")

        # C) Blood pressure
        bp_systolic, bp_diastolic = None, None
        try:
            bp_data = client.get_blood_pressure(date_str)
            msummaries = bp_data.get("measurementSummaries", [])
            if msummaries:
                bp_systolic = msummaries[0].get("systolic")
                bp_diastolic = msummaries[0].get("diastolic")
        except AttributeError:
            print("  -> `get_blood_pressure` not supported.")
        except Exception as e:
            print(f"  -> Error get_blood_pressure({date_str}): {e}")

        # D) VO2 max
        vo2max = None
        try:
            vo2_list = client.get_max_metrics(date_str)
            if isinstance(vo2_list, list):
                for entry in vo2_list:
                    if entry.get("type") == "VO2_MAX":
                        vo2max = entry.get("value")
                        break
        except AttributeError:
            print("  -> `get_max_metrics` not supported.")
        except Exception as e:
            print(f"  -> Error get_max_metrics({date_str}): {e}")

        # E) HRV summary
        hrv_data = {}
        try:
            hrv_data_temp = client.get_hrv_data(date_str)
            if hrv_data_temp is not None:
                hrv_data = hrv_data_temp
            else:
                print(f"  -> No HRV data found for {date_str}")
        except AttributeError:
            print("  -> `get_hrv_data` not supported.")
        except garminconnect.GarminConnectConnectionError as e:
            print(f"  -> Connection error on {date_str}: {e}")
        except garminconnect.GarminConnectAuthenticationError as e:
            print(f"  -> Authentication error on {date_str}: {e}")
        except garminconnect.GarminConnectTooManyRequestsError as e:
            print(f"  -> Too many requests on {date_str}: {e}")
            # Example: Wait for a longer period before retrying
            time.sleep(30)  # Wait for 30 seconds
        except Exception as e:
            print(f"  -> Error get_hrv_data({date_str}): {e}")

        hrv_summary = hrv_data.get("hrvSummary", {})
        baseline = hrv_summary.get("baseline", {})

        # Combine into row
        row = {
            "date": date_str,
            "totalSteps": daily_stats.get("totalSteps"),
            "restingHeartRate": daily_stats.get("restingHeartRate"),
            "minHeartRate": daily_stats.get("minHeartRate"),
            "maxHeartRate": daily_stats.get("maxHeartRate"),
            "totalKilocalories": daily_stats.get("totalKilocalories"),
            "activeKilocalories": daily_stats.get("activeKilocalories"),
            "bmrKilocalories": daily_stats.get("bmrKilocalories"),
            "weight_kg": weight_kg,
            "bp_systolic": bp_systolic,
            "bp_diastolic": bp_diastolic,
            "vo2max": vo2max,
            "hrv_weeklyAvg": hrv_summary.get("weeklyAvg"),
            "hrv_lastNightAvg": hrv_summary.get("lastNightAvg"),
            "hrv_lastNight5MinHigh": hrv_summary.get("lastNight5MinHigh"),
            "hrv_baseline_lowUpper": baseline.get("lowUpper"),
            "hrv_baseline_balancedLow": baseline.get("balancedLow"),
            "hrv_baseline_balancedUpper": baseline.get("balancedUpper"),
            "hrv_baseline_markerValue": baseline.get("markerValue"),
            "hrv_status": hrv_summary.get("status"),
            "hrv_feedbackPhrase": hrv_summary.get("feedbackPhrase"),
        }

        writer.writerow(row)

        current_date += timedelta(days=1)
        if SLEEP_SECONDS > 0:
            time.sleep(SLEEP_SECONDS)

print(f"\nAll done!")
print(f" => Wrote daily data to: {DAILY_DATA_CSV}")

if name == "main":
main()