A simple NikePlus API description to fetch past run metrics

fetch_nike_puls_all_activities.bash

#!/usr/bin/env bash

# fetch_nike_puls_all_activities.bash
# A simple bash script to fetch all activities and metrics from NikePlus.
# See `nike_plus_api.md` for the API details.

readonly bearer_token="$1"
if [[ -z "$bearer_token" ]]; then
  echo "Usage: $0 bearer_token"
  exit
fi

if ! type jq >/dev/null 2>&1; then
  echo "Missing jq, please install it. e.g. brew install jq" >&2
  exit 1
fi

nike_plus_api() {
  curl -H "Authorization: Bearer ${bearer_token}" "$@"
}

activity_ids=()
activities_page=0
while true; do
  activities_file="activities-${activities_page}.json"

  if [[ -z "$after_id" ]]; then
    url="https://api.nike.com/sport/v3/me/activities/after_time/0"
  else
    url="https://api.nike.com/sport/v3/me/activities/after_id/${after_id}"
  fi

  echo "Fetch $url..."
  nike_plus_api "$url" > "$activities_file"

  activity_ids=("${activity_ids[@]}" $(jq -r ".activities[].id" "$activities_file"))

  after_id=$(jq -r ".paging.after_id" "$activities_file")
  if [[ "$after_id" == "null" ]]; then
    break
  else
    activities_page=$((activities_page + 1));
  fi
done

for activity_id in ${activity_ids[@]}; do
  activity_json="activity-${activity_id}.json"
  activity_gpx="activity-${activity_id}.gpx"

  url="https://api.nike.com/sport/v3/me/activity/${activity_id}?metrics=ALL"

  echo "Fetch $url..."
  nike_plus_api "$url" > "$activity_json"
  cat "$activity_json" | jq -r '.metrics[] | select(.type == "longitude" or .type == "latitude" or .type == "elevation") | .values[].type = .type | .values[] | .start_iso8601 = ((.start_epoch_ms / 1000) | floor | todateiso8601) | [.type, .start_iso8601, .value] | @tsv' | awk -F"\t" '$1 == "latitude" {lat[$2]=$3} $1 == "longitude" {lng[$2]=$3} $1 == "elevation" {ele[$2]=$3} END {for(i in lat) {print i, lat[i], lng[i], ele[i]}}' | sort -n -k1 | awk 'NR==1 {print "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<gpx creator=\"Nike activity converter\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd\" version=\"1.1\" xmlns=\"http://www.topografix.com/GPX/1/1\">\n <metadata>\n   <time>"$1"</time>\n </metadata>\n <trk>\n  <name>"$1"</name>\n  <trkseg>"} {print "   <trkpt lat=\""$2"\" lon=\""$3"\">\n    <ele>"$4"</ele>\n    <time>"$1"</time>\n   </trkpt>"} END {print "  </trkseg>\n </trk>\n</gpx>"}' > "$activity_gpx"
done

nike_plus_api.md

NikePlus API

NikePlus hosted many my past run metrics however, they don't provide a way to export them for the customers and yet their API seems open to their partner which sounds kind of evil.

Anyways, because of that, there is definitely a simple HTTP/JSON API and we can fetch all metrics from their website.

To acquire the access, the API is using OAuth 2.0, thus need to get an access token, which is not easy by using normal OAuth authorization steps because we can't create client ID for their API. However, nike.com and their website itself is using same API and it's really easy to get own access token from the response.

Open https://www.nike.com/us/en_us/p/myactivity and login, then see developer console. Unfortunately, Nike discontinues viewing activities on the web. To get bearer token, run Charles Proxy on iPhone with SSL proxy enabling, then see the access to api.nike.com. There are bunch of requests made to api.nike.com and find the one has Authorization header with Bearer token. It seems like Base64 JSON data includes session tokens with digest.

If we can get this Bearer token, then we can call their API to fetch all metrics.

API Endpoints

There are bunch of API endpoints to access historical metrics however, there are only two API endpoints which we need to fetch past run metrics.

/sport/v3/me/activities/after_time/${time}

Use this endpoint first to start fetching activities, by giving 0 as a time. time is an integer value of UNIX epoc milliseconds.

Request

$ curl -v -H 'Authorization: Bearer ${bearer_token}' 'https://api.nike.com/sport/v3/me/activities/after_time/0'

Response

{
  "activities": [
    {
      id: "${activity_uuid}"
    },
    ...
  ],
  "paging": {
    "after_time": ${after_time},
    "after_id": "${after_activity_uuid}"
  }
}

This API response returns limited amount of latest activities from the given time. Thus, we might need to paginate to get older activities. In that case, you might see after_id key in paging.

/sport/v3/me/activities/after_id/${before_activity_uuid}

Use this endpoint to fetch another list activities to reach beginning. If paging has only before_id key, then it is last page.

/sport/v3/me/activity/${activity_uuid}?metrics=ALL

To get GPS locations, heart rates and detailed activity metrics, use this API endpoint with activity_uuid, that we can get by sport/v3/me/activities/ endpoint. Give metrics=ALL to get all details of the activity metrics.

Request

$ curl -v -H 'Authorization: Bearer ${bearer_token}' 'https://api.nike.com/sport/v3/me/activity/${activity_uuid}?metrics=ALL'

Response

{
  "id": "${activity_uuid}",
  "type": "run",
  ...
  "summaries": [
    {
      "metric": "distance",
      ...
    },
    ...
  ],
  ...
  "metric_types": [
    "distance",
    "rpe",
    "pace",
    "latitude",
    "heart_rate",
    "calories",
    "nikefuel",
    "speed",
    "longitude"
  ],
  "metrics": [
    {
      "type": "distance",
      "unit": "KM",
      ...
      "values": [
        {
          ...
        },
        ...
      ]
    },
    ...
  ],
  "moments": [
    ...
  ]
}

Here, metrics contains all detailed metrics of distance, latitude and longitude etc.