Nike+PHP

Nike+PHP is PHP class that gets you your data from the Nike+ website, including activities, all time statistics and some aspects of NikeFuel. All you need to get started is PHP 5 with cURL and JSON.

Follow Nike+PHP on twitter and Google+.

☕ Donate

If you would like to show some support for the project, why not buy me a beer, a donut or an energy drink? Please feel free to .

Changes from v4.4+

To make Nike+PHP more consistent with Nike+ there have been small changes to the code. From version 4.4+ private methods and variables now begin with an underscore and instead of run and runs, items are now referred to as either an activity or activities.

Please check the documentation and examples for more information.

↓ Download v4.5

Nike+PHP is hosted by Google Code and has been downloaded around 2936 times.

Documentation

There are a number of things you can do with Nike+PHP, the first thing you need to do is login:

<?php
  require_once 'nikeplusphp.4.5.php';
  $n = new NikePlusPHP('email@address.com', 'password');
?>

Once you've successfully logged in, you can call any of the following public methods:

Get Data

• activities($limit = null)
  • By default, returns a list of basic information that covers every activity you have registered with Nike+
  • If you set $limit to a number great than 0, returns that number of activities, the default is everything
  • If you have no activities, function returns false
• allTime()
  • your all time statistics
• activity($activityId)
  • the specific details of an activity, the unique ID of the activity must be specified
• mostRecentActivity()
  • the full details of the most recent activity registered with Nike+
• firstActivity()
  • the full details of your first activity registered with Nike+
• routes()
  • the routes you have registered with Nike+
• route($routeId)
  • the specific details of a route, the route ID must be specified

Friendly methods

• toMiles($distance)
  • convert any distance from kilometers (Nike+ default) into miles
• toHours($time)
  • works out the number of hours a duration lasted for
• toMinutes($time)
  • works out the number of minutes a duration lasted for
• toSeconds($time)
  • works out the number of seconds a duration lasted for
• padNumber($number)
  • pads number less than 10 so that they have a leading 0
• formatDuration($time, $hideZeroHours, $hideSeconds)
  • convert any number from kilometers into miles
  • hide the hours figure if the time is less than one hour
  • hides the seconds figure
• toTwoDecimalPlaces($number, $decimalPlaces)
  • shorter, and easier, way of converting a number to n decimal places
  • default decimal places is 2
• calculatePace($duration, $distance, $toMiles)
  • calculate the pace of an activity
  • $toMiles defaults to false, which means $distance is expected in km, to return miles, set this to true. You can also retern miles by ignoring $toMiles and passing a value that reflects miles for $duration.

Private methods

• _login($username, $password)
  • takes your credentials and logs into the Nike+ service
• _getNikePlusFile($filePath)
  • does the really heavy lifting by retrieving the data sent by Nike+ and returns a PHP object
  • in some cases, two steps are required, but null is still possible, espcially if your username contains foreign characters

Known issues

1. Changing your username works internally for the Nike+ website, but doesn't always work for Nike+PHP.
2. If you don't have a country set, the data returned cannot be decoded correctly. The best way around this is to make sure you have a complete profile.

Advertisement

Examples

To help you get started, here are some examples of how to use Nike+PHP.

<?php
  require_once 'nikeplusphp.4.5.php';
  $n = new NikePlusPHP('email@address.com', 'password');
  $activites = $n->activities();
  echo count($activities);
?>

<?php
  require_once 'nikeplusphp.4.5.php';
  $n = new NikePlusPHP('email@address.com', 'password');
  $activity = $n->activity($activityId);
  var_dump($activity);
?>

<?php
  require_once 'nikeplusphp.4.5.php';
  $n = new NikePlusPHP('email@address.com', 'password');
  $activity = $n->activity($activityId);
  var_dump($activity->activity->geo);
?>

<?php
  require_once 'nikeplusphp.4.5.php';
  $n = new NikePlusPHP('email@address.com', 'password');
  $activities = $n->allTime();
  echo $activities->lifetimeTotals->distance;
?>

<?php
  require_once 'nikeplusphp.4.5.php';
  $n = new NikePlusPHP('email@address.com', 'password');
  $activities = $n->allTime();
  echo $n->toMiles($activities->lifetimeTotals->distance);
?>

<?php
  require_once 'nikeplusphp.4.5.php';
  $n = new NikePlusPHP('email@address.com', 'password');
  $activities = $n->allTime();
  echo $activities->lifetimeTotals->calorie;
?>

<?php
    require_once 'nikeplusphp.4.5.php';
    $n = new NikePlusPHP('email@address.com', 'password');
    $activity = $n->mostRecentActivity();
    echo $n->formatDuration($activity->activity->metrics->duration);
?>

<?php
    require_once 'nikeplusphp.4.5.php';
    $n = new NikePlusPHP('email@address.com', 'password');
    $activity = $n->mostRecentActivity();
    echo $n->calculatePace($activity->activity->duration, $activity->activity->distance);
?>

<?php
    require_once 'nikeplusphp.4.5.php';
    $n = new NikePlusPHP('email@address.com', 'password');
    $activity = $n->mostRecentActivity();
    echo $n->calculatePace($activity->activity->duration, $activity->activity->distance, true);
?>

<?php
    require_once 'nikeplusphp.4.5.php';
    $n = new NikePlusPHP('email@address.com', 'password');
    $activity = $n->mostRecentActivity();
    echo $n->calculatePace($activity->activity->duration, $n->toMiles($activity->activity->distance));
?>

Used by

Below you will find examples of sites or products that use the Nike+PHP code.

• Charanjit Chana's portfolio
• Runnerplus Italia
• Nike+ to GPX
• Chris Poirier
• Nike+ Wordpress Plugin
• NEXUS - Nike+ for iPad
• Callum Merriman's resumé
• Patta Running Team

Help & contribute

If you need help using Nike+PHP or if you would like to contribute to the project, please feel free to send feature requests or contributions to hello@charanj.it

Here are those that have already contributed to or inspired the project:

• Charanjit Chana
• Jay Francis
• Gordon Cooper
• Tineke Timmerman

To do

As well as looking for suggestions for features, which you can submit to the email address above, I have now included a list of things I have to do on the project and features I would ultimately like to introduce.

• Get activity routes
  • This would return data associated with routes you have recorded with an activity
• Get trophies
  • This would return the trophies you have earned
• Login without supplying a username and password
  • It's come to my attention that usernames and passwords are being stored, in plain text, in databases so that multiple users from teh same system can use the functionality.
  • Create a form on this website that would return a string that you could use to login instead of having to supply a username and password.
  • I am not sure this is even possible.
• Caching
  • I have tried to implement this a few times, but everyone's needs are different making it a difficult task.
  • File based caching would be easiest to implement, and would allow you cache results for a specified amount of time.

Buy Nike+ products

Nike sell a range of products to compliment the Nike+ service, including running shoes, GPS watches and wristbands.

Cookies

This website does not knowingly drop any of it's own cookies, the only cookies used on this site are dropped by third parties and used to power analytics, advertising and social network widgets.