Trail System API Specification

URL Structure

https://trailhub.org/api/ts/{Trail System ID}

Object Response

Below are the properties that come out of a trail system GET request.

activities

Type: Array of objects

Description: An array of activity objects associated with this trail system.

Activity object properties:

  • label - String label for the activity.

  • value - Machine-friendly value representing this activity.

  • iconClass - String representing a CSS class for this activity.

  • openTrails - Number of trails listing this activity as ‘Open’.

  • closedTrails - Number of trails listing this activity as ‘Closed’.

  • cautionTrails - Number of trails listing this activity as ‘Caution’.

  • totalTrails - Total number of trails containing this activity.

  • openDistance - Total distance in kilometers of trails listing this activity as ‘Open’ or ‘Caution’.

  • totalDistance - Total distance in kilometers of trails containing this activity.

cautionTrails

Type: Number

Description: The number of trails that are listed as 'Caution’ on this trail system.

closedTrails

Type: Number

Description: The number of trails that are listed as 'Closed’ on this trail system.

createdOn

Type: Object

Description: An object of ‘_seconds’ and ‘_nanoseconds’ representing the time this trail system was created.

depthMeasurement

Type: String

Description: Either ‘centimeters’ or ‘inches’ representing the depth units used by this trail system.

description

Type: String

Description: The description of the trail system.

geoJsonUrl

Type: String

Description: A temporary URL of the GeoJson file containing this trail system’s GIS data.

geolocation

Type: Object

Description: An object of ‘_latitude’ and ‘_longitude’ representing the geolocation of this trail system.

iconPath

Type: String or Boolean

Description: A temporary URL to this trail system’s icon if one is provided. Otherwise this will be false.

inactive

Type: Boolean

Description: Is this trail system inactive?

lengthMeasurement

Type: String

Description: Either ‘kilometers’ or ‘miles’ representing the length units used by this trail system.

name

Type: String

Description: The name of this trail system.

openDistance

Type: Number

Description: The total length of open trails on this trail system in kilometers.

openTrails

Type: Number

Description: The number of trails that are listed as 'Open’ on this trail system.

phoneNumber

Type: String

Description: The public phone number of this trail system.

relatedTrailSystems

Type: Array of objects

Description: An array of trail system objects related to this trail system.

Trail system object properties:

  • tsId- String representing the related trail system’s ID.

  • name - String representing the related trail system’s name.

totalDistance

Type: Number

Description: The total length of all trails on this trail system in kilometers.

totalTrails

Type: Number

Description: The total number of trails in this trail system.

updatedOn

Type: Object

Description: An object of ‘_seconds’ and ‘_nanoseconds’ representing the time this trail system was last updated.

updates

Type: Object

Description: An object of ‘snowReport’, ‘notice’, and ‘surfaceConditions’ arrays that represent updates added to the top-level trail system (as opposed to individual trails). For example, the latest snow report would be found in the response under updates.snowReport[0]

*Detailed updates specification to come here. Please contact us with questions related to updates data or simply explore the data yourself.

website

Type: String

Description: The public website of this trail system.