Download as GPX

GET

/api/v1/activities/{activityId}/gpx

const url = 'http://localhost:8080/api/v1/activities/activity-9756441741/gpx';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/activities/activity-9756441741/gpx \
  --header 'Authorization: Bearer <token>'

Only activities recorded with GPS data can be exported. Check hasGpx on the activity first

Authorizations

apiKey

Parameters

Path Parameters

activityId

required

string

The prefixed activity identifier, activity- included.

Responses

200

The route as a GPX 1.1 document.

application/gpx+xml

string

Headers

Content-Disposition

string

401

The Authorization header was missing, malformed, or did not match the configured key.

application/json

Every error uses this shape.

object

error

required

A stable, machine readable code.

string

Allowed values: invalid_token missing_file unsupported_media_type unsupported_file_type file_too_large import_mode_not_files gpx_not_available not_found method_not_allowed bad_request forbidden internal_error

message

required

string

Examples

invalidToken

{
  "error": "invalid_token",
  "message": "A valid API token is required. Send it in the Authorization header as a Bearer token."
}

Headers

WWW-Authenticate

string

404

The activity does not exist, or it exists but has no GPS data.

application/json

Every error uses this shape.

object

error

required

A stable, machine readable code.

string

message

required

string

Examples

No such activity

{
  "error": "not_found",
  "message": "Activity \"activity-1\" not found"
}

A manual or indoor activity

{
  "error": "gpx_not_available",
  "message": "Activity \"activity-9542782314\" has no GPS or time data to export as GPX."
}