Skip to content
GuidesPlaygroundDashboard

Elevation

ModelsExpand Collapse
ElevationBatchResult = object { features, type }

GeoJSON FeatureCollection of elevation Point Features with 3D coordinates

features: array of ElevationLookupResult { geometry, properties, type }

Elevation Point Features for each queried point

geometry: GeoJsonGeometry { coordinates, type }
coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
array of number
array of array of number
array of array of array of number
array of array of array of array of number
type: "Point" or "LineString" or "Polygon" or 3 more
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: object { elevation_m }
elevation_m: optional number

Elevation in meters above mean sea level

type: "Feature"
type: "FeatureCollection"
ElevationLookupResult = object { geometry, properties, type }

GeoJSON Point Feature with 3D coordinate [lng, lat, elevation] (RFC 7946 §3.1.1)

geometry: GeoJsonGeometry { coordinates, type }
coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
array of number
array of array of number
array of array of array of number
array of array of array of array of number
type: "Point" or "LineString" or "Polygon" or 3 more
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: object { elevation_m }
elevation_m: optional number

Elevation in meters above mean sea level

type: "Feature"
ElevationProfileRequest = object { geometry }

Request body for elevation profile

geometry: GeoJsonGeometry { coordinates, type }

Path to profile (GeoJSON LineString geometry, minimum 2 points)

coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
array of number
array of array of number
array of array of array of number
array of array of array of array of number
type: "Point" or "LineString" or "Polygon" or 3 more
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
ElevationProfileResult = object { geometry, properties, type }

GeoJSON LineString Feature with 3D coordinates representing an elevation profile

geometry: GeoJsonGeometry { coordinates, type }
coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
array of number
array of array of number
array of array of array of number
array of array of array of array of number
type: "Point" or "LineString" or "Polygon" or 3 more
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: object { avg_elevation_m, max_elevation_m, min_elevation_m, 2 more }
avg_elevation_m: optional number

Average elevation along profile

max_elevation_m: optional number

Maximum elevation along profile

min_elevation_m: optional number

Minimum elevation along profile

total_ascent_m: optional number

Total elevation gain in meters

total_descent_m: optional number

Total elevation loss in meters

type: "Feature"