NAME

WebService::GarminConnect - Access data from Garmin Connect

VERSION

version 1.1.2

SYNOPSIS

With WebService::GarminConnect, you can search the activities stored on the Garmin Connect site.

use WebService::GarminConnect;

my $gc = WebService::GarminConnect->new( username => 'myuser',
                                         password => 'password' );
my @activities = $gc->activities( limit => 20 );
foreach my $a ( @activities ) {
  my $name = $a->{name};
  ...
}

FUNCTIONS

new( %options )

Creates a new WebService::GarminConnect object. One or more options may be specified:

username

(Required) The Garmin Connect username to use for searches.

password

(Required) The user's Garmin Connect password.

cache_dir

(Optional) Directory where the user's authentication token will be cached. If not specified, defaults to $HOME/.cache/webservice-garminconnect.

searchurl

(Optional) Override the default search URL for Garmin Connect.

profile

Returns the user's Garmin Connect profile

activities( %search_criteria )

Returns a list of activities matching the requested criteria. If no criteria are specified, returns all the user's activities. Possible criteria:

limit

(Optional) The maximum number of activities to return. If not specified, all the user's activities will be returned.

pagesize

(Optional) The number of activities to return in each call to Garmin Connect. (One call to this subroutine may call Garmin Connect several times to retrieve all the requested activities.) Defaults to 50.

AUTHOR

Joel Loudermilk, <joel at loudermilk.org>

BUGS

Please report any bugs or feature requests to https://github.com/jlouder/garmin-connect-perl/issues.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc WebService::GarminConnect

You can also look for information at:

COPYRIGHT & LICENSE

Copyright 2023 Joel Loudermilk.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.