Iframe parameters

Your publishable key (pk_…) with the embedding scope. It resolves your organization and authorizes the embed. Required: an embed without a resolvable publishable key renders a loader rather than a map.

A short-lived session token (sess_…). Required only when your organization enforces session tokens (require_session_token). See authentication.

The itinerary to display.

A collection to display: the studio renders the itineraries and zones it contains. Pass it on its own for a map of the whole collection, or alongside itinerary_id to open that collection focused on one of its itineraries. Which of the two layers actually draws is decided by your organization, not by this URL: each is withheld server-side when your organization turns it off, and there is no query parameter that asks for either one. An embed can therefore render a collection with its zones and no itineraries, or the reverse.

A zone to display on the map.

The activity context for the map, as a wire-form slug (for example hikingandtrail). See the activities 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 (for example temperature-actual). See the overlays table.

Enrichment overlays to stack on the map on load, each by its slug (for example hillshade). Pass each value as a repeated query parameter, like with_overlays. See the overlays 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. Omitted means "now". The offset is relative on purpose, so a shared link to "+6 days" means six days from whoever opens it, not a frozen instant.

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 control.

The overlay picker, letting the viewer toggle environmental overlays.

The preferences control for units, language, and theme.

The download control for exporting the displayed content.

The directions control.

The street view control.

The elevation profile chart.

The terrain characteristics breakdown (surface, way type).

The slope and gradient analysis.

The overlays the viewer may choose from in the overlay picker. When omitted, your organization's default allowlist applies. See the overlays table for the slugs.

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