Iframe parameters

Your publishable key (pk_…) with the publishing scope. It resolves your organization and authorizes the embed. An embed without a resolvable publishable key renders a loader rather than a map. The page that frames the embed must be on a site your organization lists in its allowed domains, and the iframe must send that page's origin: the snippet's iframe sets referrerpolicy="strict-origin-when-cross-origin", which a page-wide Referrer-Policy: no-referrer does not override. A hand-written iframe keeps it, otherwise the embed answers 401 and stays blank.

A short-lived session token (sess_…). Required only when your organization enforces session tokens (require_session_token). It may be left out: the embed then asks the page that frames it for one with mountaya:requestSessionToken, and waits for the answer, for at most 10 seconds, before it reads anything under your key. Whenever it is given, or your organization requires one, a framed embed asks as it loads and again one minute before the expires_at of each answer, and sends the token given here until the page answers, then reads everything again with the answer, the base map included: a token given here that expired before the embed loaded leaves it blank only until that first answer. The snippet's session script answers from your own endpoint. See the quickstart and authentication.

The itinerary to display.

A collection to display: the embed draws the public itineraries and the public zones it holds, each as last published. Pass it alone for a map of the whole collection, or alongside itinerary_id to open that collection focused on one of its itineraries.

Your organization decides whether a collection's itineraries and zones draw, not this URL: its with_collection_itineraries and with_collection_zones settings withhold either layer server-side when off, and no query parameter asks for them. A zone draws only once it is published and public, and no parameter shows a zone on its own.

The activity context for the map, as a wire-form slug such as hiking-and-trail. See the activity slugs table.

The basemap terrain slug. Defaults to topo when neither the URL nor your organization specifies one.

The basemap tint, light or dark.

One hex color for every itinerary segment, applied to the map lines, the start and end markers, and the elevation profile bands. Waypoint markers keep the colors they were given. Omit it to use your organization's default. Pass it empty (segments_color=) to keep each segment's own color on this embed even when your organization sets one.

A single environmental overlay to show on load, by its slug such as temperature-actual. See the overlay slugs table.

Enrichment overlays to stack on the map on load, each by its slug such as hillshade. Pass each value as a repeated query parameter, like with_overlays. See the overlay slugs table.

The forecast time for weather and snow overlays, as a count of minutes from the viewer's current clock. Negative is the past. It is clamped to the studio's forecast window, roughly 71 hours back to 6 days forward, and omitting it means "now". The offset is relative on purpose, so a shared link to "+6 days" means six days from whoever opens it.

The initial camera, carried in the URL hash rather than the query string as #view=zoom/lat/lng, optionally with bearing and pitch (#view=zoom/lat/lng/bearing/pitch). The studio writes this hash as the viewer pans and zooms, so copying a live embed URL preserves the camera.

The locale for the studio's interface, one of en, fr, es, it, de, zh, ja. See the languages reference.

The zoom and compass buttons. An embed never offers geolocation, whatever this says, because it never asks a visitor for their location. The zoom range a visitor reaches is your organization's zoom_min and zoom_max safety rules.

The overlay time cursor, letting a visitor move a weather or snow overlay backwards or forwards in time. It governs the time cursor alone: which overlays a visitor may switch on is with_overlays, and which terrains the switcher offers is with_terrains. Capped by the time-control safety rule, which, when off, refuses a tile asked for more than 15 minutes from now, so the visitor sees the present state only.

The preferences control, letting a visitor change the units (distance, travel rate, slope and temperature) and the interface language for their visit. The theme is not among them: an embed keeps your preferred_theme. Nothing a visitor changes is saved to your organization.

The download control, letting a visitor download the itinerary as GPX, FIT, TCX, GeoJSON, KML, KMZ or CSV.

The directions control, opening the turn-by-turn directions of the itinerary's routed segments as they were stored, to read, print or download as a PDF. It computes no route: a visitor never routes between points of their own.

The street view control.

The elevation profile chart. Turning it off also withdraws the analysis bars and the pace field, which are both read against it. Stays off when your organization's safety rules turn it off for embeds.

The row of key figures above the chart (distance, duration, ascent, and the rest), and the controls beside them. Turning it off also withdraws the pace field, which renders in that row.

The profile's computed terrain analysis: the surface and way-type bars under the elevation chart, and the surface, way type, trail difficulty, slope and aspect readings of its hover readout. On a pointer device the bars are a hover detail: they reveal while the cursor is over the profile and collapse when it leaves. Needs with_profile_elevation, which is what reveals them. Stays off when your organization's safety rules turn it off for embeds: the rule removes the analysis from what the embed is served.

The pace field, which lets a visitor enter their own travel rate and read the itinerary re-timed for it. It sits in the figures row beside the segment chooser, and a reset beside it returns the visitor to your own pacing.

The override belongs to that visitor's session alone. Nothing is saved, the itinerary's committed speeds are untouched, and clearing the field brings your own figures back. The field is shown in whichever speed or pace unit the visitor reads, following the same two preferences the rest of the studio does.

Needs with_profile_elevation and with_profile_characteristics. With either off, the field is withheld however the embed is configured.

The overlays the viewer may choose from in the layers control. When omitted, your organization's default list applies, and an empty list, or one holding *, offers the whole catalog. Your organization's overlay allowlist caps it: an overlay listed here but not admitted there renders no tiles. See the overlay slugs table.

The basemap terrains the viewer may switch between. When omitted, your organization's default allowlist applies.