Enums
The Data API spells every enum value in SCREAMING_SNAKE_CASE. The Map Studio and Tile APIs spell the shared ones in kebab-case: lowercase the value and turn each underscore into a hyphen.
Activity identifier. Each activity uses a different routing profile optimized for its terrain and movement style.
HIKING_AND_TRAILenum value
Hiking and trail running on footpaths. Balanced routing that favors trails, paths, and quieter, greener ways; waypoints must lie within about 400 m of a routable path. Default speed: ~4.5 km/h.
PROFESSIONAL_TRAILenum value
Expert trail routing on the same trail network as HIKING_AND_TRAIL, tuned for maximum reach: most-direct routing, no scenic bias, and unlimited waypoint snapping, so routes can start or end far off-network and follow very unconventional lines (only ferries are excluded). Also supports freehand line editing. Default speed: ~8 km/h.
RUNNINGenum value
Road and path running. Fastest-preference routing that favors runnable surfaces; waypoints must lie within about 400 m of a routable way. For trail running, use HIKING_AND_TRAIL. Default speed: ~10 km/h.
ROAD_CYCLINGenum value
Road cycling on paved roads and cycleways. Routes on the paved network with surface analysis. Default speed: ~25 km/h.
GRAVEL_BIKEenum value
Gravel biking on mixed-surface roads and tracks. Unavailable: the activity catalog does not list it, and a request naming it is refused, for routing, freehand line editing and analysis alike. Default speed: ~20 km/h.
MOUNTAIN_BIKEenum value
Mountain biking on off-road trails and singletrack. Unavailable: the activity catalog does not list it, and a request naming it is refused, for routing, freehand line editing and analysis alike. Default speed: ~15 km/h.
BACKCOUNTRY_SKIINGenum value
Backcountry (off-piste) skiing. Freehand line editing only; turn-by-turn directions are not available, so you draw the route yourself. Default speed: ~4 km/h.
SKI_TOURINGenum value
Ski touring, ascending and descending off-piste. Routes on the trail network with unlimited waypoint snapping, so high-alpine points far from mapped trails still route; also supports freehand line editing. Default speed: ~4 km/h.
CROSS_COUNTRY_SKIINGenum value
Cross-country (nordic) skiing on groomed trails. Balanced routing that favors designated tracks; waypoints must lie within about 400 m of a routable way. Default speed: ~8 km/h.
SNOWSHOE_WALKINGenum value
Snowshoe walking on snow-covered terrain. Routes on the trail network with relaxed waypoint snapping (up to a few km) for off-trail backcountry points; also supports freehand line editing. Default speed: ~3.5 km/h.
Trail difficulty as tagged in OpenStreetMap. Walking activities are graded on the SAC hiking scale (sac_scale) and cycling activities on the mountain-biking scale (mtb:scale); a stretch carries a value from whichever scale matches the activity, and the value names its own scale.
UNKNOWNenum value
No difficulty tag on this stretch. The most common value; it carries no difficulty claim.
HIKINGenum value
Hiking. Trail is well cleared; flat or slightly sloped, no fall hazard.
MOUNTAIN_HIKINGenum value
Mountain hiking. Trail is continuous, may have exposed sections; sure-footedness required.
DEMANDING_MOUNTAIN_HIKINGenum value
Demanding mountain hiking. Partly exposed with fall hazard; hands occasionally needed; sure-footedness, good boots and alpine experience required.
ALPINE_HIKINGenum value
Alpine hiking. Often pathless with exposed scrambling; familiarity with exposed terrain and an ice axe may be required.
DEMANDING_ALPINE_HIKINGenum value
Demanding alpine hiking. Frequent scrambling with climbing up to UIAA grade II; high alpine experience required.
DIFFICULT_ALPINE_HIKINGenum value
Difficult alpine hiking. Sustained exposed scrambling and climbing; mountaineering equipment and experience required.
MTB_0enum value
mtb:scale=0. Solid surface, mostly gravel or packed dirt; no significant obstacles.
MTB_1enum value
mtb:scale=1. Mostly solid with loose sections and small obstacles such as roots or stones.
MTB_2enum value
mtb:scale=2. Loose surface with larger roots and stones; occasional dismounting expected.
MTB_3enum value
mtb:scale=3. Slippery ground with large obstacles and switchbacks; advanced technique required.
MTB_4enum value
mtb:scale=4. Loose scree, large boulders and tight switchbacks; expert technique required.
MTB_5enum value
mtb:scale=5. Very steep and blocked with boulders and scree; extreme technique required.
MTB_6enum value
mtb:scale=6. Barely rideable; sustained extreme obstacles and exposure.
Whether a stretch of route crosses a way that charges a toll, as tagged in OpenStreetMap (toll). Resolved per activity: a way tolled only for heavy goods vehicles is not a tollway on foot, while a way tolled for everyone is.
NONEenum value
No toll on this stretch. Never reported: tollwayInfo lists only the stretches that cross a tollway.
TOLLWAYenum value
This stretch crosses a way that charges a toll for the activity's mode of travel.
An access restriction tagged on a way in OpenStreetMap (the access key and its mode-specific variants such as foot), resolved for the activity's mode of travel.
NOenum value
Access is forbidden (access=no).
CUSTOMERSenum value
Access is limited to customers of the adjoining premises (access=customers).
DESTINATIONenum value
Access is limited to reaching a destination on the way itself, not passing through (access=destination).
DELIVERYenum value
Access is limited to deliveries (access=delivery).
PRIVATEenum value
Access is limited to the owner and their guests (access=private).
PERMISSIVEenum value
The owner tolerates passage and may withdraw it at any time (access=permissive). This grants access rather than restricting it, so it is reported but is not treated as a hazard.
PERMITenum value
Access requires an individual permit (access=permit).
RESTRICTEDenum value
Access is restricted without the tagging saying to whom (access=restricted). Treated as a genuine restriction.
UNKNOWNenum value
The way carries an access restriction whose nature is not recorded (access=unknown). Treated as a genuine restriction, because an unrecorded restriction is not an absent one.
SERVICEenum value
Access is limited to vehicles servicing the way or the premises on it (access=service).
AGRICULTURALenum value
Access is limited to agricultural traffic (access=agricultural). Reported so a route over a farm track is never a surprise, but NOT treated as a hazard: farm tracks are ordinary terrain on foot.
FORESTRYenum value
Access is limited to forestry traffic (access=forestry). Reported but, like AGRICULTURAL, not treated as a hazard.
A route-level hazard a directions request can ask to route around.
TOLLWAYenum value
A way that charges a toll for the activity's mode of travel.
RESTRICTED_ACCESSenum value
A way carrying a genuine access restriction. PERMISSIVE, AGRICULTURAL and FORESTRY ways do not count: the owner tolerates passage on the first, and the other two are ordinary terrain on foot.
What a directions request's avoid list actually achieved. Without it an unchanged route is ambiguous: a caller cannot tell "there was nothing to avoid" from "no route survived the constraint".
NOT_REQUESTEDenum value
The request carried no avoid list.
NOT_NEEDEDenum value
Avoidance was requested and no stretch of the route was found on a named hazard, so nothing was re-routed. A hazard known only from the routing engine's route-level warning leaves no stretch to route around, so read the advisories as well.
APPLIEDenum value
The route returned was re-routed with the offending ways excluded, up to about 10 km of hazardous way in total, so a longer hazard can still be crossed. It may also carry a DIFFERENT hazard, so read the advisories rather than assuming.
NO_ROUTEenum value
The hazards were found and excluded, but no route survived, so the route returned is the original one and still crosses them. Usually means a waypoint sits on the hazardous way itself, which no exclusion can route around. Also the outcome of a re-route that failed on Mountaya's side, which an INTERNAL_ERROR entry in errors then flags beside the route.
Classification of the ground surface a stretch of route is carried on: what it is paved with, rather than the character of the way.
UNKNOWNenum value
Unknown or unclassified surface.
PAVEDenum value
Generic paved surface.
UNPAVEDenum value
Generic unpaved surface.
ASPHALTenum value
Asphalt surface.
CONCRETEenum value
Concrete surface.
COBBLESTONEenum value
Cobblestone surface.
METALenum value
Metal surface.
WOODenum value
Wooden surface.
COMPACTED_GRAVELenum value
Compacted gravel surface.
FINE_GRAVELenum value
Fine gravel surface.
GRAVELenum value
Gravel surface.
DIRTenum value
Dirt surface.
GROUNDenum value
Natural ground surface.
ICEenum value
Ice surface.
PAVING_STONESenum value
Paving stones surface.
SANDenum value
Sand surface.
WOODCHIPSenum value
Woodchips surface.
GRASSenum value
Grass surface.
GRASS_PAVERenum value
Grass paver surface.
Classification of the kind of way a stretch of route follows: the character of the path itself, rather than what it is paved with.
UNKNOWNenum value
Unknown or unclassified way type.
STATE_ROADenum value
State road or highway.
ROADenum value
Standard road.
STREETenum value
Urban street.
PATHenum value
Walking or hiking path.
TRACKenum value
Unpaved track.
CYCLEWAYenum value
Designated cycleway.
FOOTWAYenum value
Pedestrian footway.
STEPSenum value
Stairs or steps.
FERRYenum value
Ferry crossing.
CONSTRUCTIONenum value
Road under construction.
Maneuver type for a turn-by-turn direction step, derived from the routing engine's instruction analysis. Clients template localized instruction text from this type plus the step's name.
TURN_LEFTenum value
Turn left.
TURN_RIGHTenum value
Turn right.
SHARP_LEFTenum value
Sharp left.
SHARP_RIGHTenum value
Sharp right.
SLIGHT_LEFTenum value
Slight left.
SLIGHT_RIGHTenum value
Slight right.
CONTINUEenum value
Continue straight.
ENTER_ROUNDABOUTenum value
Enter a roundabout.
EXIT_ROUNDABOUTenum value
Exit a roundabout.
UTURNenum value
Make a U-turn.
GOALenum value
Arrive at the destination.
DEPARTenum value
Depart from the start.
KEEP_LEFTenum value
Keep left.
KEEP_RIGHTenum value
Keep right.
UNKNOWNenum value
Unknown or unclassified maneuver.
User-facing locale code. Determines the language of localized strings returned by the API.
ENenum value
English.
FRenum value
French.
ESenum value
Spanish.
ITenum value
Italian.
DEenum value
German.
ZHenum value
Chinese (Simplified).
JAenum value
Japanese.
Geocoding result layer. Indicates the administrative or feature scope of a geocoded place, ordered from coarsest (country) to finest (house, natural feature).
COUNTRYenum value
Country-level administrative boundary.
REGIONenum value
Region or state within a country.
COUNTYenum value
County or department within a region.
CITYenum value
City, town, or village.
DISTRICTenum value
District or neighborhood within a city.
POSTCODEenum value
Postal code area.
STREETenum value
Street or road.
HOUSEenum value
House or building address.
POIenum value
Point of interest.
NATURALenum value
Natural feature such as a mountain, lake, or forest.
OpenStreetMap primitive type identifying how a feature is represented in the OSM data model.
NODEenum value
OSM node (a single point with coordinates).
WAYenum value
OSM way (an ordered list of nodes forming a line or polygon).
RELATIONenum value
OSM relation (a grouping of nodes, ways, or other relations).
Coarse classification of a geocoded place. Used both as a response field on Place (clients can render category-specific UI) and as the dimension along which PlaceCategoriesInput filters forward / reverse geocoding output.
POPULATED_PLACEenum value
Populated places like cities, towns, villages, hamlets, and suburbs.
ADMINISTRATIVE_AREAenum value
Administrative boundaries like regions, counties, departments, districts, and localities.
COUNTRYenum value
Country-level results such as France or Switzerland.
NATURAL_FEATUREenum value
Natural features like mountain peaks, lakes, glaciers, rivers, and forests.
TRANSIT_STATIONenum value
Transit stations like train stations, bus terminals, airports, and cable car stations.
AMENITYenum value
Amenities like cafes, restaurants, shops, tourist attractions, and leisure venues.
ADDRESSenum value
Addresses like streets, house numbers, and postcodes.
OTHERenum value
Catch-all for places that do not fit any of the other categories.
Point-of-interest category. Classifies POIs surfaced by search and on the map by their primary outdoor function.
HUTenum value
Mountain hut or refuge providing shelter and meals.
PEAKenum value
Mountain summit or peak.
PASSenum value
Mountain pass or col between valleys.
VIEWPOINTenum value
Scenic viewpoint or panorama spot.
PARKINGenum value
Parking area for vehicles, often at a trailhead.
WATER_SOURCEenum value
Drinkable water source such as a spring or fountain.
CAFEenum value
Cafe or coffee shop.
RESTAURANTenum value
Restaurant serving meals.
SUPERMARKETenum value
Supermarket or grocery store.
PHARMACYenum value
Pharmacy or chemist.
TOILETSenum value
Public toilets.
CAMPSITEenum value
Campsite or camping pitch.
SHELTERenum value
Bivouac shelter or emergency refuge with no staff.
CABLE_CARenum value
Cable car, gondola, or chairlift station.
BUS_STATIONenum value
Bus station or major bus stop.
TRAIN_STATIONenum value
Train station.
AIRPORTenum value
Airport or airfield.
ACCOMMODATIONenum value
Hotel, hostel, guest house, or chalet.
CARAVAN_SITEenum value
Caravan or camper site.
HOSPITALenum value
Hospital.
Search target entity. Identifies which kind of entity a unified search query should match against.
PLACESenum value
Named places from the geocoder (cities, regions, natural features).
POISenum value
Points of interest such as huts, peaks, parking, and amenities.
WAYSenum value
Named ways such as trails, paths, and roads.
ITINERARIESenum value
Itineraries of your key's organization.
COLLECTIONSenum value
Collections of your key's organization.
ZONESenum value
Zones of your key's organization.
Field on a searchable entity that matched a search query. Used by full-text search to indicate which property produced the match.
NAMEenum value
The entity's name field matched the query.
DESCRIPTIONenum value
The entity's description field matched the query.
Severity level of a zone annotation.
INFOenum value
Informational notice with no hazard.
RESOLVEDenum value
Previously reported issue that has been resolved.
WARNINGenum value
Moderate hazard or caution area.
DANGERenum value
Serious hazard or danger area.
How a zone's area was drawn or computed. Every mode stores a single Polygon; the mode records the tool that produced it, so a client can reopen the zone in the same editor. A zone computed from a source is always POLYGON.
POLYGONenum value
Drawn vertex by vertex, or computed from a source.
CIRCLEenum value
A circle around a center, stored as the polygon that traces it.
SENSORenum value
A sensor's coverage band between two radii, stored as the polygon that traces it.
SECTORenum value
A pie slice swept from a center, stored as the polygon that traces it.
FREEHANDenum value
Drawn freehand.
Publishable-key scope that can authorize a Data API field, as declared by the @pkeyScope directive. The two are alternatives, never a pair: a key reaches this API directly with DATA, or through Mountaya's MCP server with MCP, and holding one grants nothing about the other.
DATAenum value
Query this API directly, sending the key and a session token yourself.
MCPenum value
Reach this API through Mountaya's MCP server.
A service or facility available at a waypoint. An amenity is a fact about the place, independent of the icon its author chose to draw it with: a waypoint drawn as a hut may offer WATER, HOT_MEAL and ACCOMMODATION, and the two vocabularies never substitute for one another.
WATERenum value
Drinking water available, from a tap, spring or refill point.
DRINKSenum value
Non-water drinks served, such as tea, coffee or soft drinks.
FOODenum value
Solid food available, without implying a cooked meal.
HOT_MEALenum value
A cooked, hot meal is served.
SNACKSenum value
Light snacks, bars or fruit available.
MEDICALenum value
Staffed medical post with qualified personnel.
FIRST_AIDenum value
First-aid kit or basic care available, not necessarily staffed.
TOILETSenum value
Public toilets.
SHOWERSenum value
Showers or washing facilities.
DROP_BAGenum value
Drop bags may be deposited or collected here.
LUGGAGE_STORAGEenum value
Luggage may be left in storage, beyond race drop bags.
ASSISTANCEenum value
Personal assistance or a support crew is permitted here.
REST_AREAenum value
A dedicated area to sit and recover.
ACCOMMODATIONenum value
Beds or overnight accommodation available.
SHELTERenum value
Unstaffed shelter from weather, such as a bothy or refuge.
CAMPINGenum value
Tents may be pitched here.
PICNICenum value
Picnic tables or an outdoor eating area.
SHOPenum value
A shop where supplies can be bought.
PARKINGenum value
Vehicle parking available.
SHUTTLEenum value
A shuttle service serves this point.
PUBLIC_TRANSPORTenum value
Public transport, such as a bus or train, serves this point.
CABLE_CARenum value
A cable car, gondola or chairlift serves this point.
POWER_CHARGINGenum value
Electric bike or vehicle charging available.
WIFIenum value
Wireless internet access available.
MOBILE_SIGNALenum value
Reliable mobile network coverage at this point.
WASTEenum value
Waste and recycling disposal available.
PET_FRIENDLYenum value
Dogs or other pets are allowed here.
WHEELCHAIR_ACCESSenum value
Reachable and usable by wheelchair.
VIEWPOINTenum value
A notable view or scenic overlook.
TIMING_CHECKPOINTenum value
Timing is recorded here, such as a chip mat or manual check-in.
How a custom waypoint property's value should be rendered. The value is always carried as a string; this says how to interpret it, so a renderer never has to guess from the content.
TEXTenum value
Plain text, rendered verbatim.
NUMBERenum value
A number, rendered with the reader's locale grouping and decimal separator.
DURATIONenum value
A duration in seconds, zero or more, rendered as hours and minutes.
DISTANCEenum value
A distance in meters, zero or more, rendered in the reader's length unit.
URLenum value
An absolute URL, rendered as a link.
DATEenum value
An RFC 3339 date-time, or a bare YYYY-MM-DD date, rendered in the reader's locale.
The closed vocabulary of extensions.code on an error entry.
BAD_REQUESTenum value
The request was malformed: on this API, a body not sent as application/json or that does not decode as a JSON object, or a request asking to upgrade its connection. The body is never echoed back.
VALIDATION_FAILEDenum value
One or more input fields were rejected. One entry is emitted per refused field, each carrying its own path. An input is checked in stages and a later stage runs only once the earlier ones pass, so correct what was reported and send again.
UNAUTHORIZEDenum value
No publishable key, a secret key sent in its place, or an unknown or revoked key, including any key of a canceled organization; or a session token that is absent, invalid, expired or minted for another key.
PAYMENT_REQUIREDenum value
The organization does not hold the Data API, or it is billed by card and has no payment method on file. The Data API is held while the metered subscription the organization's first card opens is in force, or by the organization's agreement with Mountaya. The product is checked before the key's scope, so a key without the scope in an organization that does not hold the Data API is answered this rather than FORBIDDEN. The payment method is checked after the scope, so the same key in an organization with no payment method on file is answered FORBIDDEN. exportItinerary also answers it for the draft of an itinerary whose organization does not hold Map Publishing.
FORBIDDENenum value
The key does not carry a scope that authorizes this field, or the request's Origin or Referer is not among the organization's allowed domains.
NOT_FOUNDenum value
The addressed resource does not exist or is not visible to your key. The two are one answer, so it never confirms that an id exists.
METHOD_NOT_ALLOWEDenum value
The request used an HTTP method other than POST.
CONFLICTenum value
Never sent by this API, which changes no state. Part of the shared vocabulary.
PAYLOAD_TOO_LARGEenum value
The request body is over 32 MiB, the ceiling the Map Studio API holds most bodies to. It is refused once the credential has been checked and before anything reads the body, and no field runs. Or, as the entry of itinerary or exportItinerary in a 200 response, the itinerary holds more than 500,000 positions, more than one answer carries: that field is refused, its entry at the input as a whole rather than at any one of its fields, and the rest of the request runs.
TOO_MANY_REQUESTSenum value
A limit on the organization's requests to this API is spent, and the response carries Retry-After, the whole seconds until it lifts. Either its per-minute limit, 60 requests a minute unless its agreement sets another figure, which every key of the organization draws on: wait out the minute. Or its monthly allowance, 300,000 unless its agreement sets another figure or leaves it unlimited, which counts the root fields answered without an error over the organization's current billing period, the MCP server's included: every request of the organization's own clients is refused until the next billing period begins. A request made with a session token minted for studio-embedded counts toward neither, and is refused instead once a bound of its own is spent, as this API's introduction states. So is a request from Mountaya's web application, made signed in to it rather than with a key, whose session cannot be checked yet because too many sessions sent from the calling address have been refused within the minute: the session may be perfectly valid, which is why it is not a 401, and Retry-After names the seconds until the minute's window turns.
INTERNAL_ERRORenum value
An unexpected server-side failure. Opaque by construction: no field path, no metadata.
NOT_IMPLEMENTEDenum value
The field cannot be answered here. Sent only by exportItinerary, when downloads are unavailable.
BAD_GATEWAYenum value
Never sent by this API. Part of the shared vocabulary.
SERVICE_UNAVAILABLEenum value
Never sent by this API. Part of the shared vocabulary.
GATEWAY_TIMEOUTenum value
The request was still running when its time budget of 30 seconds ran out, and it is answered with HTTP status 504 in place of whatever was in flight, with no data. It is the same code the REST surfaces answer a spent budget with. Nothing about the request is wrong: send it again, or narrow it, a smaller matrix or fewer root fields, where it asks a lot.
File format for a route or itinerary export. FIT and TCX additionally accept an ExportVariant selecting the course or activity file type; supplying one for any other format is rejected.
GPXenum value
GPS Exchange Format (.gpx), compatible with most GPS devices and apps.
GEOJSONenum value
GeoJSON FeatureCollection (.geojson), a standard format for geographic data.
KMLenum value
Keyhole Markup Language (.kml), the Google Earth and Maps interchange format.
KMZenum value
Compressed Keyhole Markup Language (.kmz), a zipped KML document.
FITenum value
Flexible and Interoperable Data Transfer (.fit), the native Garmin, Wahoo and Coros format. Accepts an ExportVariant.
TCXenum value
Training Center XML (.tcx), accepted by Garmin Connect, Strava and TrainingPeaks. Accepts an ExportVariant. A course's name is cut to the 15 characters the format allows, and a course point's to 10.
CSVenum value
Comma-separated values (.csv), a flat coordinate table for spreadsheets and analysis. Lossy: segments, styling and metadata are not preserved, so a CSV export cannot be imported back. A name beginning with =, +, -, @, a tab or a carriage return, or with the full-width =, +, - or @, is prefixed with a single quote (') so a spreadsheet reads it as text.
File type of a time-series export, the distinction FIT and TCX draw natively.
COURSEenum value
A planned route a device can navigate turn by turn. The default when no variant is named.
ACTIVITYenum value
The same geometry as a completed workout, with timestamps synthesized from each segment's planned start and estimated duration. The timeline only moves forward: a segment's planned start is used when it comes after the previous segment's end; otherwise the segment starts one second after it.
Unit family a range value is measured in. Shared vocabulary with the Map Studio API, which carries the same two members as RangeType for a sourced zone's range values, because a sourced zone is the polygon an isochrone computed. Each surface spells it idiomatically: TIME here, time there.
TIMEenum value
A budget of travel time, in seconds.
DISTANCEenum value
A budget of travel distance, in meters.
Metric type for matrix computation.
DISTANCEenum value
Distance in meters.
DURATIONenum value
Duration in seconds.
Compass octant of a downhill aspect direction.
NORTHenum value
North-facing (337.5-22.5 degrees).
NORTH_EASTenum value
Northeast-facing (22.5-67.5 degrees).
EASTenum value
East-facing (67.5-112.5 degrees).
SOUTH_EASTenum value
Southeast-facing (112.5-157.5 degrees).
SOUTHenum value
South-facing (157.5-202.5 degrees).
SOUTH_WESTenum value
Southwest-facing (202.5-247.5 degrees).
WESTenum value
West-facing (247.5-292.5 degrees).
NORTH_WESTenum value
Northwest-facing (292.5-337.5 degrees).
Slope steepness band, matching the steepness overlay's legend. Covers 25 to 45+ degrees, the angle range where slopes become most hazardous.
FROM_25_TO_30enum value
25 to 30 degrees.
FROM_30_TO_35enum value
30 to 35 degrees.
FROM_35_TO_40enum value
35 to 40 degrees.
FROM_40_TO_45enum value
40 to 45 degrees.
ABOVE_45enum value
Above 45 degrees. Terrain rarely holds a deep snowpack at this angle but often presents other hazards such as cliffs.