Unofficial dotnet garmin connect client
This package allows you to request your device, activity and health data from your Garmin Connect account.
WARNING! Use the library only for personal automation without too many accounts. For other needs request access to the developer program.
dotnet add package Unofficial.Garmin.Connectvar authParameters = new BasicAuthParameters("<garmin login>", "<garmin password>");
var client = new GarminConnectClient(new GarminConnectContext(new HttpClient(), authParameters));var authParameters = new BasicAuthParameters("<garmin login>", "<garmin password>");
var mfaCode = new StaticMfaCode();
var client = new GarminConnectClient(new GarminConnectContext(new HttpClient(), authParameters, mfaCode));Example IMfaCodeProvider implementation:
public class StaticMfaCode : IMfaCodeProvider
{
public Task<string> GetMfaCodeAsync()
{
// 1. static code
var code = "123456";
// 2. wait for input from console
// var code = Console.ReadLine().Trim();
// 3. any other approach: read from file, env var, form input, etc.
return Task.FromResult(code);
}
}To avoid re-authenticating on every startup, pass an ITokenCache implementation. The OAuth2 token is reused until it expires; once it does, the client renews it by re-exchanging the cached OAuth1 token instead of doing a full login, which is both cheaper and far less likely to hit Garmin's rate limiting. A full login only happens if there is no cached OAuth1 token or Garmin rejects it.
In-memory cache (default, cleared on restart):
// InMemoryTokenCache is used automatically when no cache is specified
var client = new GarminConnectClient(new GarminConnectContext(new HttpClient(), authParameters, mfaCode));File cache (persists across restarts):
var tokenCache = new FileTokenCache("/path/to/token.json");
var client = new GarminConnectClient(
new GarminConnectContext(new HttpClient(), authParameters, mfaCode, tokenCache));Custom cache (Redis, database, etc.):
Implement ITokenCache to plug in any storage backend:
public class RedisTokenCache : ITokenCache
{
public async Task<OAuth2Token> GetOAuth2Token(CancellationToken cancellationToken)
{
// read and return token from Redis, or null if missing/expired
}
public async Task SetOAuth2Token(OAuth2Token token, CancellationToken cancellationToken)
{
// write token to Redis with TTL of token.ExpiresIn seconds
}
// Optional — omitting these two falls back to a full login every time the OAuth2
// token expires, which is what earlier versions of this interface always did.
public async Task<OAuth1Token> GetOAuth1Token(CancellationToken cancellationToken)
{
// read and return the long-lived OAuth1 token from Redis, or null if missing
}
public async Task SetOAuth1Token(OAuth1Token token, CancellationToken cancellationToken)
{
// write the OAuth1 token to Redis (no TTL — it outlives the OAuth2 token)
}
}- build
./pack.sh - pack
./publish.sh
Tests are TUnit integration tests running on Microsoft.Testing.Platform, and they require real Garmin credentials.
Credentials are read from the GARMIN_LOGIN / GARMIN_PASSWORD environment variables, and
fall back to .NET user secrets
when those are not set.
Because IDE test runners start the test host without your shell environment, user secrets are
the recommended way to run tests locally — they are stored in your home directory
(~/.microsoft/usersecrets/<UserSecretsId>/secrets.json), never inside the repository:
dotnet user-secrets set GARMIN_LOGIN your_login --project Garmin.Connect.Tests
dotnet user-secrets set GARMIN_PASSWORD your_password --project Garmin.Connect.TestsIn JetBrains Rider you can also manage them via right-click on Garmin.Connect.Tests →
Tools | .NET User Secrets.
Note that user secrets are stored in plain text — they are kept out of source control, but they are not encrypted. Use environment variables in CI.
global.json opts dotnet test into the Microsoft.Testing.Platform runner, so the project is
passed with --project and tests are filtered with --treenode-filter:
# All tests, credentials from the shell
GARMIN_LOGIN=your_login GARMIN_PASSWORD=your_password ./test.sh
# All tests, credentials from user secrets
dotnet test --project Garmin.Connect.Tests/Garmin.Connect.Tests.csproj
# Single test class
dotnet test --project Garmin.Connect.Tests/Garmin.Connect.Tests.csproj \
--treenode-filter "/*/*/OwnerTests/*"
# Single test method
dotnet test --project Garmin.Connect.Tests/Garmin.Connect.Tests.csproj \
--treenode-filter "/*/*/OwnerTests/GetSocialProfile_NotNull"- The first vision from cyberjunky/python-garminconnect
- Icons made by Freepik from www.flaticon.com
- Converter JSON to C# app.quicktype.io
- and Garmin for the best devices