# Route

A route with its facts and its spot and place links.

Group: Objects.

## Fields

- `routeId` (string, required): The route's id.
- `name` (string or null, required): The route's name.
- `activity` (string or null, required): hike, walk, bike, drive, ski or paddle; null means hike.
- `sacGrade` (string or null, required): The grade as written in gradeScale.
- `gradeScale` (string or null, required): sac, via_ferrata, cai, yds, mtb, whitewater or other; null means sac.
- `effortLabel` (string or null, required): Easy, Moderate, Hard (free text).
- `durationMin` (number or null, required): Duration in minutes (see durationBasis).
- `gainM` (number or null, required): Elevation gain in meters.
- `descentM` (number or null, required): Descent in meters.
- `distanceKm` (number or null, required): Distance in kilometers.
- `start` (string or null, required): The trailhead in words.
- `startMapsUrl` (string or null, required): Map link to the trailhead.
- `transit` (array of TransitNote, required): Transit notes per mode.
  Fields of TransitNote: https://developers.sceniq.earth/fields/transit-note.md
- `description` (string or null, required): The route in the creator's words.
- `equipment` (array of strings or null, required): Gear; [] means explicitly none, null means unknown.
- `sources` (array of strings, required): Where the facts come from.
- `extraProps` (array of ExtraProp, required): Free label and value rows.
  Fields of ExtraProp: https://developers.sceniq.earth/fields/extra-prop.md
- `track` (RouteTrack or null, required): The route line.
  Fields of RouteTrack: https://developers.sceniq.earth/fields/route-track.md
- `status` (StatusNotice or null, required): A closure notice.
  Fields of StatusNotice: https://developers.sceniq.earth/fields/status-notice.md
- `season` (RouteSeason or null, required): When the route can be walked.
  Fields of RouteSeason: https://developers.sceniq.earth/fields/route-season.md
- `variants` (array of RouteVariant, required): Alternatives.
  Fields of RouteVariant: https://developers.sceniq.earth/fields/route-variant.md
- `stages` (array of RouteStage, required): Days or legs of a trek.
  Fields of RouteStage: https://developers.sceniq.earth/fields/route-stage.md
- `segments` (array of RouteSegment, required): Sections with their own access.
  Fields of RouteSegment: https://developers.sceniq.earth/fields/route-segment.md
- `shape` (string or null, required): loop, out_and_back or one_way. One of `loop`, `out_and_back`, `one_way`.
- `durationBasis` (string or null, required): What durationMin counts: round_trip, one_way or ascent. One of `round_trip`, `one_way`, `ascent`.
- `ascentMin` (number or null, required): Minutes up.
- `descentMin` (number or null, required): Minutes down.
- `sourceGrade` (string or null, required): The source's own grade.
- `figureSources` (array of FigureSource, required): Where each number comes from.
  Fields of FigureSource: https://developers.sceniq.earth/fields/figure-source.md
- `reviewNotes` (string or null, required): Notes for the creator's review, never shown to buyers.
- `factsCheckedOn` (string or null, required): The day the facts were last checked (YYYY-MM-DD).
- `reviewBy` (string or null, required): The day the facts need a new check (YYYY-MM-DD).
- `createdAt` (number, required): When the row was created (Unix time in milliseconds).
- `updatedAt` (number, required): When the row last changed (Unix time in milliseconds).
- `spots` (array of objects, required): The spots the route passes, in order.
  - `spotKey` (string, required): The spot's key.
  - `order` (number, required): Position on the route.
  - `quickest` (boolean, required): true when this is the fastest approach to the spot.
  - `role` (string, required): required: the way in. optional: a walk from the spot that never sets its Accessibility. One of `required`, `optional`.
- `facilities` (array of objects, required): The places the route uses, in order.
  - `facilityId` (string, required): The place's id.
  - `order` (number, required): Position on the route.

## Used by

- [list_routes](https://developers.sceniq.earth/reference/list_routes.md)