Layers
The layer catalog a map draws from: the terrain base maps, satellite among them, the grouped overlays, the itinerary and zone layers, and the elevation raster the terrains are shaded from, with the tile sources and styling each one resolves to. Read this before rendering: it is what tells a client which layers exist and how to register them.
The built-in map layer catalog: the terrain base maps, the grouped overlay layers, and the two layers that render itineraries and zones. itineraries and zones are typed as overlays because that is what they are to a map: one tile source each, registered the same way. But they are singular and always present, so they sit beside the overlays groups rather than inside them.
elevationobject
The height raster a renderer turns into three-dimensional relief. Every catalog carries one, so a client registers the terrain source unconditionally rather than branching on whether heights are available.
idstring (uuid)
Identifier of the elevation raster. It belongs to no terrain, so it has an identifier of its own, which stays the same across releases.
tile_sizeinteger (int32)
One of: 512
The tile size to declare when this source is added to a map. Only one value is served, and declaring a different one offsets every zoom level.
urlstring (uri)
URL of the TileJSON document describing the elevation source, ready to hand to a map renderer unmodified. It is the Tile API's getElevationTileJson, whose tile template is the Tile API's getElevationTile, so the heights are drawn under the credential a map sends there, and no URL carries a credential of Mountaya's. Uncapped, unlike a URL a caller supplies: Mountaya issues this one, so there is no untrusted input for a ceiling to bound.
itinerariesobject
The single layer that draws the itineraries this credential reaches, in the studio scope organization_id names when the catalog was asked for one, which its URL template then carries. It is typed as an overlay because that is what it is to a map, one tile source registered the same way, and it sits here rather than inside overlays because it is singular and always present: there is one of it, for every caller, and no group to file it under.
capabilitiesobject
Which of this overlay's options each side of the wire resolves, so read this before building the control. Where server.timestamp is true, a tile's timestamp selects the instant it depicts. Where it is false, the instant sent is ignored, and any change over time is the client's to draw from what it already holds. Two settings are refused. A timestamp that is not an RFC 3339 instant, or that lies more than three days before or six days after the request, is a 400 on every overlay tile, whether or not the overlay has a time dimension. Where server.timestamp is true, an instant more than 15 minutes from the current one is a 403 unless the organization's with_overlays_control safety rule allows it, a share-token request included.
clientobject
Which of the optional behaviours the CLIENT is expected to provide for this overlay, such as restyling data it already holds when the moment changes.
timestampboolean
Whether this side of the wire resolves the moment the overlay depicts.
serverobject
Which of the optional behaviours the SERVER provides for this overlay, such as serving the tile for a requested instant.
timestampboolean
Whether this side of the wire resolves the moment the overlay depicts.
content_typestring
One of: image/png, application/x-protobuf, image/webp
What the overlay's tiles carry, which decides how they are drawn: a raster overlay is an image layer, a vector one is styled by the layers its specification declares. For a raster overlay it names the format of the tiles within its source's zoom range; a tile asked for deeper than that is cut from its ancestor and is always PNG, so read each tile's Content-Type header rather than this.
idstring (uuid)
Identifier of the overlay. slug is the value the Tile API takes; this is the one the catalog keys on.
localesobject
The overlay's display name and blurb per language. A language absent here is null rather than missing, which is the case to fall back from.
deLocaleMap | null
The German strings for this legend. Null when the legend carries no German translation, which is the case a client falls back from rather than renders.
enLocaleMap | null
The English strings for this legend. Null when the legend carries no English translation, which is the case a client falls back from rather than renders.
esLocaleMap | null
The Spanish strings for this legend. Null when the legend carries no Spanish translation, which is the case a client falls back from rather than renders.
frLocaleMap | null
The French strings for this legend. Null when the legend carries no French translation, which is the case a client falls back from rather than renders.
itLocaleMap | null
The Italian strings for this legend. Null when the legend carries no Italian translation, which is the case a client falls back from rather than renders.
jaLocaleMap | null
The Japanese strings for this legend. Null when the legend carries no Japanese translation, which is the case a client falls back from rather than renders.
zhLocaleMap | null
The Chinese strings for this legend. Null when the legend carries no Chinese translation, which is the case a client falls back from rather than renders.
slugstring
Stable, URL-safe identifier of the overlay, and the value the Tile API takes in /v1/overlays/{overlay}/.... Lowercase letters, digits and single hyphens, so it is safe in a path segment without escaping. The shape is declared here and on that path parameter identically, because a value this read hands a client is a value that client sends straight back.
sourcesarray of TileSource
Tile sources to register with the map renderer before this overlay can be drawn.
attributionstring
Attribution HTML to display on the map for this source: the credit of whoever supplies its data, Mountaya for a resource source and the data provider for an overlay. Pass through to the attribution option of map.addSource().
idstring
Unique source identifier. Use it as the first argument to map.addSource() and as the source of every layer that draws from it.
layersarray of TileLayer
Render-layers to draw from this source, in paint order. Each becomes one map.addLayer() call.
filterarray of any
Optional MapLibre/Mapbox filter expression restricting which features the layer renders. Pass through to the filter option of map.addLayer(). Omitted when no filter applies; never null and never an empty array.
idstring
Unique layer identifier. Use it as the first argument to map.addLayer().
keystring
Stable, human-readable concept slug grouping render-layers that depict the same map concept (e.g. "parking", "hillshade"). Unlike id, which is the per-layer unique identifier, key MAY repeat across several layers of the same overlay when one concept is rendered with multiple layers (a fill plus a symbol, for instance). Clients group and toggle layers by key; id remains the uniqueness guarantee.
layoutobject | null
MapLibre/Mapbox layout properties for this layer (e.g. visibility, symbol placement). Pass through to the layout option of map.addLayer(). Null when the layer needs no layout overrides.
legendobject
Optional legend describing how to read the layer's colors or scale. Drives the map UI legend; not consumed by map.addLayer(). Omitted when the layer has no legend; never null.
kindstring
One of: row, compass
How the legend is laid out: row draws the steps below as an ordered row of color swatches, and compass as a compass dial, for a directional overlay such as aspect/slope.
localesobject
The legend's title and step labels per language. A language absent here is null rather than missing, which is the case to fall back from.
deLocaleMap | null
The German strings for this legend. Null when the legend carries no German translation, which is the case a client falls back from rather than renders.
enLocaleMap | null
The English strings for this legend. Null when the legend carries no English translation, which is the case a client falls back from rather than renders.
esLocaleMap | null
The Spanish strings for this legend. Null when the legend carries no Spanish translation, which is the case a client falls back from rather than renders.
frLocaleMap | null
The French strings for this legend. Null when the legend carries no French translation, which is the case a client falls back from rather than renders.
itLocaleMap | null
The Italian strings for this legend. Null when the legend carries no Italian translation, which is the case a client falls back from rather than renders.
jaLocaleMap | null
The Japanese strings for this legend. Null when the legend carries no Japanese translation, which is the case a client falls back from rather than renders.
zhLocaleMap | null
The Chinese strings for this legend. Null when the legend carries no Chinese translation, which is the case a client falls back from rather than renders.
stepsarray of TileLegendStep
Ordered color stops mapping a value (or bucket) to the color the layer paints for it, from low to high. Drives a graduated or categorical legend.
colorstring
CSS color the layer paints for this step (e.g. "#1c7ed6"). Matches the color used in the layer's paint expression.
stepstring
Label for the value or bucket this color represents, such as a threshold like "20" or a range like "25 - 30". It is the same in every language: the legend's translated text is in its locales.
unitstring
One of: km/h, degrees, m, cm, celsius, percent
The unit the step values are measured in, for the suffix a legend prints beside each one. Absent when the steps are categories rather than quantities.
paintobject | null
MapLibre/Mapbox paint properties for this layer (colors, opacity, widths, data-driven expressions). Pass through to the paint option of map.addLayer(). Null when the layer relies on style defaults.
sourcestring
Identifier of the source this layer draws from. Matches the id of the enclosing tile source.
source_layerstring
Name of the layer within a vector tile to render (e.g. "fills", "points", "lines"). Pass through to the source-layer option of map.addLayer(). Only meaningful for vector sources.
typestring
One of: raster, hillshade, fill, line, circle, symbol
How this layer draws, and what paint may carry: a map library maps it onto its own layer type, so pass it through rather than inferring one from the source.
zoom_maxinteger (int32)
Highest zoom level at which the layer is drawn. Pass to the maxzoom option of map.addLayer().
zoom_mininteger (int32)
Lowest zoom level at which the layer is drawn. Pass to the minzoom option of map.addLayer().
sizeinteger (int32)
One of: 256, 512
Edge length in pixels of one raster tile, for map.addSource()'s tileSize. Omitted for vector sources, which have no pixel size of their own.
tilesarray of string
Tile URL templates with {z}, {x}, and {y} placeholders that the map library expands per tile. Usually a single entry pointing at the matching {z}/{x}/{y} endpoint. Hand the template to the map library with its placeholders intact: the library substitutes them as it pans and zooms, so a template expanded before it is handed over produces one tile rather than a map. An overlay's template, and in a layer catalog the itinerary and zone layers' templates, carry the organization_id the specification or the catalog was asked for with, when one was sent, as a query string of its own, so a credential added to such a template joins it with & rather than starting a second ?.
typestring
One of: vector, raster, raster-dem
What kind of data the source serves, which decides how a map library reads its tiles. A raster-dem source carries elevation rather than pixels, so it feeds terrain and hillshade rather than being drawn directly.
zoom_maxinteger (int32)
Deepest zoom a map library requests this source's tiles at. A layer drawn from the source can reach deeper, and a map overzooms the source's tiles for it. It says where to ask rather than what is refused: a tile asked for deeper is still served, and on a specification served to a publishable key the value is brought within the organization's zoom bounds.
zoom_mininteger (int32)
Shallowest zoom a map library requests this source's tiles at. Like zoom_max, it says where to ask rather than what is refused, and on a specification served to a publishable key it is brought within the organization's zoom bounds.
overlaysarray of CategoryOverlays
The overlay catalog, grouped. Each group holds the overlays a caller can add to a map. Under a publishable key or a share token the overlays a map draws are the ones the organization's overlay allowlist admits, and the Tile API holds every overlay tile to it. The Tile API's own catalog, getTileLayers, lists only those, dropping a group left with none; the Map Studio API's getLayers lists every overlay whatever the allowlist says. From Mountaya's web application both list every overlay, in the person's own space and in each organization they are a member of, while the Tile API draws in the studio scope organization_id names: the points of interest alone in the person's own space and in an organization that does not hold Map Studio, and every overlay in one that does.
childrenarray of Overlay
The overlays in this group. These are the renderable entries; the group itself is not.
capabilitiesobject
Which of this overlay's options each side of the wire resolves, so read this before building the control. Where server.timestamp is true, a tile's timestamp selects the instant it depicts. Where it is false, the instant sent is ignored, and any change over time is the client's to draw from what it already holds. Two settings are refused. A timestamp that is not an RFC 3339 instant, or that lies more than three days before or six days after the request, is a 400 on every overlay tile, whether or not the overlay has a time dimension. Where server.timestamp is true, an instant more than 15 minutes from the current one is a 403 unless the organization's with_overlays_control safety rule allows it, a share-token request included.
clientobject
Which of the optional behaviours the CLIENT is expected to provide for this overlay, such as restyling data it already holds when the moment changes.
timestampboolean
Whether this side of the wire resolves the moment the overlay depicts.
serverobject
Which of the optional behaviours the SERVER provides for this overlay, such as serving the tile for a requested instant.
timestampboolean
Whether this side of the wire resolves the moment the overlay depicts.
content_typestring
One of: image/png, application/x-protobuf, image/webp
What the overlay's tiles carry, which decides how they are drawn: a raster overlay is an image layer, a vector one is styled by the layers its specification declares. For a raster overlay it names the format of the tiles within its source's zoom range; a tile asked for deeper than that is cut from its ancestor and is always PNG, so read each tile's Content-Type header rather than this.
idstring (uuid)
Identifier of the overlay. slug is the value the Tile API takes; this is the one the catalog keys on.
localesobject
The overlay's display name and blurb per language. A language absent here is null rather than missing, which is the case to fall back from.
deLocaleMap | null
The German strings for this legend. Null when the legend carries no German translation, which is the case a client falls back from rather than renders.
enLocaleMap | null
The English strings for this legend. Null when the legend carries no English translation, which is the case a client falls back from rather than renders.
esLocaleMap | null
The Spanish strings for this legend. Null when the legend carries no Spanish translation, which is the case a client falls back from rather than renders.
frLocaleMap | null
The French strings for this legend. Null when the legend carries no French translation, which is the case a client falls back from rather than renders.
itLocaleMap | null
The Italian strings for this legend. Null when the legend carries no Italian translation, which is the case a client falls back from rather than renders.
jaLocaleMap | null
The Japanese strings for this legend. Null when the legend carries no Japanese translation, which is the case a client falls back from rather than renders.
zhLocaleMap | null
The Chinese strings for this legend. Null when the legend carries no Chinese translation, which is the case a client falls back from rather than renders.
slugstring
Stable, URL-safe identifier of the overlay, and the value the Tile API takes in /v1/overlays/{overlay}/.... Lowercase letters, digits and single hyphens, so it is safe in a path segment without escaping. The shape is declared here and on that path parameter identically, because a value this read hands a client is a value that client sends straight back.
sourcesarray of TileSource
Tile sources to register with the map renderer before this overlay can be drawn.
attributionstring
Attribution HTML to display on the map for this source: the credit of whoever supplies its data, Mountaya for a resource source and the data provider for an overlay. Pass through to the attribution option of map.addSource().
idstring
Unique source identifier. Use it as the first argument to map.addSource() and as the source of every layer that draws from it.
layersarray of TileLayer
Render-layers to draw from this source, in paint order. Each becomes one map.addLayer() call.
filterarray of any
Optional MapLibre/Mapbox filter expression restricting which features the layer renders. Pass through to the filter option of map.addLayer(). Omitted when no filter applies; never null and never an empty array.
idstring
Unique layer identifier. Use it as the first argument to map.addLayer().
keystring
Stable, human-readable concept slug grouping render-layers that depict the same map concept (e.g. "parking", "hillshade"). Unlike id, which is the per-layer unique identifier, key MAY repeat across several layers of the same overlay when one concept is rendered with multiple layers (a fill plus a symbol, for instance). Clients group and toggle layers by key; id remains the uniqueness guarantee.
layoutobject | null
MapLibre/Mapbox layout properties for this layer (e.g. visibility, symbol placement). Pass through to the layout option of map.addLayer(). Null when the layer needs no layout overrides.
legendobject
Optional legend describing how to read the layer's colors or scale. Drives the map UI legend; not consumed by map.addLayer(). Omitted when the layer has no legend; never null.
kindstring
One of: row, compass
How the legend is laid out: row draws the steps below as an ordered row of color swatches, and compass as a compass dial, for a directional overlay such as aspect/slope.
localesobject
The legend's title and step labels per language. A language absent here is null rather than missing, which is the case to fall back from.
stepsarray of TileLegendStep
Ordered color stops mapping a value (or bucket) to the color the layer paints for it, from low to high. Drives a graduated or categorical legend.
unitstring
One of: km/h, degrees, m, cm, celsius, percent
The unit the step values are measured in, for the suffix a legend prints beside each one. Absent when the steps are categories rather than quantities.
paintobject | null
MapLibre/Mapbox paint properties for this layer (colors, opacity, widths, data-driven expressions). Pass through to the paint option of map.addLayer(). Null when the layer relies on style defaults.
sourcestring
Identifier of the source this layer draws from. Matches the id of the enclosing tile source.
source_layerstring
Name of the layer within a vector tile to render (e.g. "fills", "points", "lines"). Pass through to the source-layer option of map.addLayer(). Only meaningful for vector sources.
typestring
One of: raster, hillshade, fill, line, circle, symbol
How this layer draws, and what paint may carry: a map library maps it onto its own layer type, so pass it through rather than inferring one from the source.
zoom_maxinteger (int32)
Highest zoom level at which the layer is drawn. Pass to the maxzoom option of map.addLayer().
zoom_mininteger (int32)
Lowest zoom level at which the layer is drawn. Pass to the minzoom option of map.addLayer().
sizeinteger (int32)
One of: 256, 512
Edge length in pixels of one raster tile, for map.addSource()'s tileSize. Omitted for vector sources, which have no pixel size of their own.
tilesarray of string
Tile URL templates with {z}, {x}, and {y} placeholders that the map library expands per tile. Usually a single entry pointing at the matching {z}/{x}/{y} endpoint. Hand the template to the map library with its placeholders intact: the library substitutes them as it pans and zooms, so a template expanded before it is handed over produces one tile rather than a map. An overlay's template, and in a layer catalog the itinerary and zone layers' templates, carry the organization_id the specification or the catalog was asked for with, when one was sent, as a query string of its own, so a credential added to such a template joins it with & rather than starting a second ?.
typestring
One of: vector, raster, raster-dem
What kind of data the source serves, which decides how a map library reads its tiles. A raster-dem source carries elevation rather than pixels, so it feeds terrain and hillshade rather than being drawn directly.
zoom_maxinteger (int32)
Deepest zoom a map library requests this source's tiles at. A layer drawn from the source can reach deeper, and a map overzooms the source's tiles for it. It says where to ask rather than what is refused: a tile asked for deeper is still served, and on a specification served to a publishable key the value is brought within the organization's zoom bounds.
zoom_mininteger (int32)
Shallowest zoom a map library requests this source's tiles at. Like zoom_max, it says where to ask rather than what is refused, and on a specification served to a publishable key it is brought within the organization's zoom bounds.
idstring (uuid)
Identifier of the overlay group.
localesobject
The category's display name per language. Render from here rather than from slug: the slug is a stable identifier and is not translated.
deLocaleMap | null
The German strings for this legend. Null when the legend carries no German translation, which is the case a client falls back from rather than renders.
enLocaleMap | null
The English strings for this legend. Null when the legend carries no English translation, which is the case a client falls back from rather than renders.
esLocaleMap | null
The Spanish strings for this legend. Null when the legend carries no Spanish translation, which is the case a client falls back from rather than renders.
frLocaleMap | null
The French strings for this legend. Null when the legend carries no French translation, which is the case a client falls back from rather than renders.
itLocaleMap | null
The Italian strings for this legend. Null when the legend carries no Italian translation, which is the case a client falls back from rather than renders.
jaLocaleMap | null
The Japanese strings for this legend. Null when the legend carries no Japanese translation, which is the case a client falls back from rather than renders.
zhLocaleMap | null
The Chinese strings for this legend. Null when the legend carries no Chinese translation, which is the case a client falls back from rather than renders.
slugstring
Stable, URL-safe identifier of the overlay group. Unlike the display name in locales, it does not change between languages or releases. Lowercase letters, digits and single hyphens, the same shape every slug on this surface carries.
terrainsarray of Terrain
The terrain base maps a caller can draw itineraries and zones on.
idstring (uuid)
Identifier of the terrain. slug is the value a person reads; this is the one the catalog keys on.
localesobject
The terrain's display name per language. Render from here rather than from slug: the slug is a stable identifier and is not translated.
deLocaleMap | null
The German strings for this legend. Null when the legend carries no German translation, which is the case a client falls back from rather than renders.
enLocaleMap | null
The English strings for this legend. Null when the legend carries no English translation, which is the case a client falls back from rather than renders.
esLocaleMap | null
The Spanish strings for this legend. Null when the legend carries no Spanish translation, which is the case a client falls back from rather than renders.
frLocaleMap | null
The French strings for this legend. Null when the legend carries no French translation, which is the case a client falls back from rather than renders.
itLocaleMap | null
The Italian strings for this legend. Null when the legend carries no Italian translation, which is the case a client falls back from rather than renders.
jaLocaleMap | null
The Japanese strings for this legend. Null when the legend carries no Japanese translation, which is the case a client falls back from rather than renders.
zhLocaleMap | null
The Chinese strings for this legend. Null when the legend carries no Chinese translation, which is the case a client falls back from rather than renders.
slugstring
Stable, URL-safe identifier of the terrain. Unlike the display name in locales, it does not change between languages or releases. Lowercase letters, digits and single hyphens, the same shape every slug on this surface carries.
variantsobject
The light and dark renditions of this terrain. Both are always present, so a client follows the user's color scheme without fetching the catalog again.
darkobject
The rendition to draw under a dark color scheme.
styleobject
This rendition as a complete map style document, for a client that renders the terrain as it is given.
urlstring (uri)
URL of the style document, ready to hand to a map renderer unmodified. Uncapped, unlike a URL a caller supplies: Mountaya issues this one, so there is no untrusted input for a ceiling to bound.
tilesobject
This rendition as a tile source alone, described by a TileJSON document, for a client composing a style of its own.
sizeinteger (int32)
One of: 512
The tile size to declare when this source is added to a map. Only one value is served, and declaring a different one offsets every zoom level.
urlstring (uri)
URL of the TileJSON document describing this rendition's tiles: where they are fetched from, their zoom range and their attribution. It is the Tile API's getTerrainTileJson, whose tile template is the Tile API's getTerrainTile, so the tiles are drawn under the credential a map sends there, and no URL carries a credential of Mountaya's. It is a resolvable address rather than a tile template, so register it as the source's url rather than among its tiles, and hand it to the map renderer unmodified. Uncapped, unlike a URL a caller supplies: Mountaya issues this one, so there is no untrusted input for a ceiling to bound.
lightobject
The rendition to draw under a light color scheme.
styleobject
This rendition as a complete map style document, for a client that renders the terrain as it is given.
urlstring (uri)
URL of the style document, ready to hand to a map renderer unmodified. Uncapped, unlike a URL a caller supplies: Mountaya issues this one, so there is no untrusted input for a ceiling to bound.
tilesobject
This rendition as a tile source alone, described by a TileJSON document, for a client composing a style of its own.
sizeinteger (int32)
One of: 512
The tile size to declare when this source is added to a map. Only one value is served, and declaring a different one offsets every zoom level.
urlstring (uri)
URL of the TileJSON document describing this rendition's tiles: where they are fetched from, their zoom range and their attribution. It is the Tile API's getTerrainTileJson, whose tile template is the Tile API's getTerrainTile, so the tiles are drawn under the credential a map sends there, and no URL carries a credential of Mountaya's. It is a resolvable address rather than a tile template, so register it as the source's url rather than among its tiles, and hand it to the map renderer unmodified. Uncapped, unlike a URL a caller supplies: Mountaya issues this one, so there is no untrusted input for a ceiling to bound.
zonesobject
The single layer that draws the zones this credential reaches, in the studio scope organization_id names when the catalog was asked for one, which its URL template then carries. Typed as an overlay and kept outside the overlays groups for the reason itineraries gives.
capabilitiesobject
Which of this overlay's options each side of the wire resolves, so read this before building the control. Where server.timestamp is true, a tile's timestamp selects the instant it depicts. Where it is false, the instant sent is ignored, and any change over time is the client's to draw from what it already holds. Two settings are refused. A timestamp that is not an RFC 3339 instant, or that lies more than three days before or six days after the request, is a 400 on every overlay tile, whether or not the overlay has a time dimension. Where server.timestamp is true, an instant more than 15 minutes from the current one is a 403 unless the organization's with_overlays_control safety rule allows it, a share-token request included.
clientobject
Which of the optional behaviours the CLIENT is expected to provide for this overlay, such as restyling data it already holds when the moment changes.
timestampboolean
Whether this side of the wire resolves the moment the overlay depicts.
serverobject
Which of the optional behaviours the SERVER provides for this overlay, such as serving the tile for a requested instant.
timestampboolean
Whether this side of the wire resolves the moment the overlay depicts.
content_typestring
One of: image/png, application/x-protobuf, image/webp
What the overlay's tiles carry, which decides how they are drawn: a raster overlay is an image layer, a vector one is styled by the layers its specification declares. For a raster overlay it names the format of the tiles within its source's zoom range; a tile asked for deeper than that is cut from its ancestor and is always PNG, so read each tile's Content-Type header rather than this.
idstring (uuid)
Identifier of the overlay. slug is the value the Tile API takes; this is the one the catalog keys on.
localesobject
The overlay's display name and blurb per language. A language absent here is null rather than missing, which is the case to fall back from.
deLocaleMap | null
The German strings for this legend. Null when the legend carries no German translation, which is the case a client falls back from rather than renders.
enLocaleMap | null
The English strings for this legend. Null when the legend carries no English translation, which is the case a client falls back from rather than renders.
esLocaleMap | null
The Spanish strings for this legend. Null when the legend carries no Spanish translation, which is the case a client falls back from rather than renders.
frLocaleMap | null
The French strings for this legend. Null when the legend carries no French translation, which is the case a client falls back from rather than renders.
itLocaleMap | null
The Italian strings for this legend. Null when the legend carries no Italian translation, which is the case a client falls back from rather than renders.
jaLocaleMap | null
The Japanese strings for this legend. Null when the legend carries no Japanese translation, which is the case a client falls back from rather than renders.
zhLocaleMap | null
The Chinese strings for this legend. Null when the legend carries no Chinese translation, which is the case a client falls back from rather than renders.
slugstring
Stable, URL-safe identifier of the overlay, and the value the Tile API takes in /v1/overlays/{overlay}/.... Lowercase letters, digits and single hyphens, so it is safe in a path segment without escaping. The shape is declared here and on that path parameter identically, because a value this read hands a client is a value that client sends straight back.
sourcesarray of TileSource
Tile sources to register with the map renderer before this overlay can be drawn.
attributionstring
Attribution HTML to display on the map for this source: the credit of whoever supplies its data, Mountaya for a resource source and the data provider for an overlay. Pass through to the attribution option of map.addSource().
idstring
Unique source identifier. Use it as the first argument to map.addSource() and as the source of every layer that draws from it.
layersarray of TileLayer
Render-layers to draw from this source, in paint order. Each becomes one map.addLayer() call.
filterarray of any
Optional MapLibre/Mapbox filter expression restricting which features the layer renders. Pass through to the filter option of map.addLayer(). Omitted when no filter applies; never null and never an empty array.
idstring
Unique layer identifier. Use it as the first argument to map.addLayer().
keystring
Stable, human-readable concept slug grouping render-layers that depict the same map concept (e.g. "parking", "hillshade"). Unlike id, which is the per-layer unique identifier, key MAY repeat across several layers of the same overlay when one concept is rendered with multiple layers (a fill plus a symbol, for instance). Clients group and toggle layers by key; id remains the uniqueness guarantee.
layoutobject | null
MapLibre/Mapbox layout properties for this layer (e.g. visibility, symbol placement). Pass through to the layout option of map.addLayer(). Null when the layer needs no layout overrides.
legendobject
Optional legend describing how to read the layer's colors or scale. Drives the map UI legend; not consumed by map.addLayer(). Omitted when the layer has no legend; never null.
kindstring
One of: row, compass
How the legend is laid out: row draws the steps below as an ordered row of color swatches, and compass as a compass dial, for a directional overlay such as aspect/slope.
localesobject
The legend's title and step labels per language. A language absent here is null rather than missing, which is the case to fall back from.
deLocaleMap | null
The German strings for this legend. Null when the legend carries no German translation, which is the case a client falls back from rather than renders.
enLocaleMap | null
The English strings for this legend. Null when the legend carries no English translation, which is the case a client falls back from rather than renders.
esLocaleMap | null
The Spanish strings for this legend. Null when the legend carries no Spanish translation, which is the case a client falls back from rather than renders.
frLocaleMap | null
The French strings for this legend. Null when the legend carries no French translation, which is the case a client falls back from rather than renders.
itLocaleMap | null
The Italian strings for this legend. Null when the legend carries no Italian translation, which is the case a client falls back from rather than renders.
jaLocaleMap | null
The Japanese strings for this legend. Null when the legend carries no Japanese translation, which is the case a client falls back from rather than renders.
zhLocaleMap | null
The Chinese strings for this legend. Null when the legend carries no Chinese translation, which is the case a client falls back from rather than renders.
stepsarray of TileLegendStep
Ordered color stops mapping a value (or bucket) to the color the layer paints for it, from low to high. Drives a graduated or categorical legend.
colorstring
CSS color the layer paints for this step (e.g. "#1c7ed6"). Matches the color used in the layer's paint expression.
stepstring
Label for the value or bucket this color represents, such as a threshold like "20" or a range like "25 - 30". It is the same in every language: the legend's translated text is in its locales.
unitstring
One of: km/h, degrees, m, cm, celsius, percent
The unit the step values are measured in, for the suffix a legend prints beside each one. Absent when the steps are categories rather than quantities.
paintobject | null
MapLibre/Mapbox paint properties for this layer (colors, opacity, widths, data-driven expressions). Pass through to the paint option of map.addLayer(). Null when the layer relies on style defaults.
sourcestring
Identifier of the source this layer draws from. Matches the id of the enclosing tile source.
source_layerstring
Name of the layer within a vector tile to render (e.g. "fills", "points", "lines"). Pass through to the source-layer option of map.addLayer(). Only meaningful for vector sources.
typestring
One of: raster, hillshade, fill, line, circle, symbol
How this layer draws, and what paint may carry: a map library maps it onto its own layer type, so pass it through rather than inferring one from the source.
zoom_maxinteger (int32)
Highest zoom level at which the layer is drawn. Pass to the maxzoom option of map.addLayer().
zoom_mininteger (int32)
Lowest zoom level at which the layer is drawn. Pass to the minzoom option of map.addLayer().
sizeinteger (int32)
One of: 256, 512
Edge length in pixels of one raster tile, for map.addSource()'s tileSize. Omitted for vector sources, which have no pixel size of their own.
tilesarray of string
Tile URL templates with {z}, {x}, and {y} placeholders that the map library expands per tile. Usually a single entry pointing at the matching {z}/{x}/{y} endpoint. Hand the template to the map library with its placeholders intact: the library substitutes them as it pans and zooms, so a template expanded before it is handed over produces one tile rather than a map. An overlay's template, and in a layer catalog the itinerary and zone layers' templates, carry the organization_id the specification or the catalog was asked for with, when one was sent, as a query string of its own, so a credential added to such a template joins it with & rather than starting a second ?.
typestring
One of: vector, raster, raster-dem
What kind of data the source serves, which decides how a map library reads its tiles. A raster-dem source carries elevation rather than pixels, so it feeds terrain and hillshade rather than being drawn directly.
zoom_maxinteger (int32)
Deepest zoom a map library requests this source's tiles at. A layer drawn from the source can reach deeper, and a map overzooms the source's tiles for it. It says where to ask rather than what is refused: a tile asked for deeper is still served, and on a specification served to a publishable key the value is brought within the organization's zoom bounds.
zoom_mininteger (int32)
Shallowest zoom a map library requests this source's tiles at. Like zoom_max, it says where to ask rather than what is refused, and on a specification served to a publishable key it is brought within the organization's zoom bounds.
/v1/layersReturns the map layer catalog: the terrain base maps (satellite among them), the grouped overlay layers (for example slopes), the elevation raster the terrains are shaded from, and the two layers that draw itineraries and zones. Which overlay groups it carries follows the studio scope the optional organization_id names. Under a publishable key or a share token it may name only the credential's own organization and changes nothing, and the overlays a map draws there are the ones the organization's overlay allowlist admits, to which the Tile API holds every overlay tile. From Mountaya's web application it chooses between the person's own space and an organization they are a member of, as its description states, and the catalog lists every overlay in either, the ones the Tile API does not draw in that scope included.
Query parameters
organization_idstring (uuid)
in query
The studio scope the map draws in, named by the organization's identifier. A value that is not a UUID in its canonical form, or the nil UUID, is a 400 naming organization_id.
Response 200
The layer catalog: the terrains, the elevation raster, the overlay groups, and the itinerary and zone layers, each with the tile sources and styling it resolves to. When the request named an organization_id, the tile URL template of every overlay in overlays and of the itinerary and zone layers carries the same organization_id under sources[].tiles, so the tiles a map fetches are drawn in the scope the catalog was served for: from Mountaya's web application, the overlays that scope draws and the itineraries and zones it holds.
extensionsobject
Top-level extensions map for 2xx responses. Mirrors the GraphQL-spec response extensions: a free-form map for response-scoped metadata.
metadataobject
Response-scoped metadata. Its shape is per-operation: the operation that emits it names the schema, and an operation that documents none never emits this field.
dataLayers
The built-in map layer catalog: the terrain base maps, the grouped overlay layers, and the two layers that render itineraries and zones. itineraries and zones are typed as overlays because that is what they are to a map: one tile source each, registered the same way. But they are singular and always present, so they sit beside the overlays groups rather than inside them.
See the Layers object.
Errors 400, 401, 402, 403, 404, 429, 500, 504. See Errors.
curl -s https://api.mountaya.com/v1/layers \
-H "X-API-Key: pk_your_publishable_key" | jq '.data'{
"data": {
"elevation": {
"id": "55763749-32b4-42d5-9f62-b6c51ef54d99",
"tile_size": 512,
"url": "https://tiles.mountaya.com/v1/elevation/tiles.json"
},
"terrains": [
{
"id": "cad23e29-49da-4009-9f99-63dbcd963dc0",
"slug": "topo",
"locales": {
"de": null,
"en": {
"name": "Summer topo"
},
"es": null,
"fr": {
"name": "Topo été"
},
"it": null,
"ja": null,
"zh": null
},
"variants": {
"light": {
"style": {
"url": "https://tiles.mountaya.com/v1/terrains/topo/light/style"
},
"tiles": {
"url": "https://tiles.mountaya.com/v1/terrains/topo/light/tiles.json",
"size": 512
}
},
"dark": {
"style": {
"url": "https://tiles.mountaya.com/v1/terrains/topo/dark/style"
},
"tiles": {
"url": "https://tiles.mountaya.com/v1/terrains/topo/dark/tiles.json",
"size": 512
}
}
}
}
],
"overlays": [
{
"id": "1b7e4d92-6c03-4f85-a2d7-9e0b5c8a3f14",
"slug": "weather",
"locales": {
"de": null,
"en": {
"name": "Weather"
},
"es": null,
"fr": {
"name": "Météo"
},
"it": null,
"ja": null,
"zh": null
},
"children": [
{
"id": "5e1de8a6-7930-445a-8145-5301cf3c25f7",
"slug": "wind",
"content_type": "application/x-protobuf",
"capabilities": {
"client": {
"timestamp": false
},
"server": {
"timestamp": true
}
},
"locales": {
"de": null,
"en": {
"name": "Wind"
},
"es": null,
"fr": {
"name": "Vent"
},
"it": null,
"ja": null,
"zh": null
},
"sources": [
{
"id": "5e1de8a6-7930-445a-8145-5301cf3c25f7",
"type": "vector",
"attribution": "<a href=\"https://www.meteoblue.com/\" target=\"_blank\">© meteoblue</a>",
"tiles": [
"https://tiles.mountaya.com/v1/overlays/wind/{z}/{x}/{y}"
],
"zoom_min": 7,
"zoom_max": 18,
"layers": [
{
"id": "overlay/b2618568-38a1-449b-8318-386b9b42cb4e",
"key": "wind",
"type": "fill",
"source": "5e1de8a6-7930-445a-8145-5301cf3c25f7",
"source_layer": "windLayer",
"zoom_min": 7,
"zoom_max": 18,
"layout": null,
"paint": {
"fill-color": "#5D8DBD",
"fill-opacity": 0.6
}
}
]
}
]
}
]
}
],
"itineraries": {
"id": "2d8f4e6a-1b3c-4d5e-9f8a-7c6b5a4d3e2f",
"slug": "itineraries",
"content_type": "application/x-protobuf",
"capabilities": {
"client": {
"timestamp": false
},
"server": {
"timestamp": false
}
},
"locales": {
"de": null,
"en": {
"name": "Itineraries"
},
"es": null,
"fr": {
"name": "Itinéraires"
},
"it": null,
"ja": null,
"zh": null
},
"sources": [
{
"id": "9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d",
"type": "vector",
"attribution": "<a href=\"https://mountaya.com/\" target=\"_blank\">© Mountaya</a>",
"tiles": [
"https://tiles.mountaya.com/v1/itineraries/{z}/{x}/{y}"
],
"zoom_min": 5,
"zoom_max": 18,
"layers": [
{
"id": "itineraries/9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d/lines",
"key": "",
"type": "line",
"source": "9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d",
"source_layer": "itinerary_lines",
"zoom_min": 5,
"zoom_max": 18,
"layout": {
"line-cap": "round",
"line-join": "round"
},
"paint": {
"line-color": "#2f80ed",
"line-width": 3
}
}
]
}
]
},
"zones": {
"id": "58e506ec-06dd-44ef-8924-5c90ee360fe2",
"slug": "zones",
"content_type": "application/x-protobuf",
"capabilities": {
"client": {
"timestamp": false
},
"server": {
"timestamp": true
}
},
"locales": {
"de": null,
"en": {
"name": "Zones"
},
"es": null,
"fr": {
"name": "Zones"
},
"it": null,
"ja": null,
"zh": null
},
"sources": [
{
"id": "fc79978a-0e9c-4491-a5e4-b0de35a8b508",
"type": "vector",
"attribution": "<a href=\"https://mountaya.com/\" target=\"_blank\">© Mountaya</a>",
"tiles": [
"https://tiles.mountaya.com/v1/zones/{z}/{x}/{y}"
],
"zoom_min": 5,
"zoom_max": 18,
"layers": [
{
"id": "zones/fc79978a-0e9c-4491-a5e4-b0de35a8b508/fills",
"key": "",
"type": "fill",
"source": "fc79978a-0e9c-4491-a5e4-b0de35a8b508",
"source_layer": "fills",
"zoom_min": 5,
"zoom_max": 18,
"layout": null,
"paint": {
"fill-color": "#F03E3E",
"fill-opacity": 0.25
}
}
]
}
]
}
}
}