Skip to content
GuidesPlaygroundDashboard

Elevation

Look up elevation at one or more points
ElevationLookupResult Elevation.Lookup(ElevationLookupParams?parameters, CancellationTokencancellationToken = default)
GET/api/v1/elevation
Look up elevation for multiple coordinates
ElevationBatchResult Elevation.Batch(ElevationBatchParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/elevation/batch
Elevation profile along coordinates
ElevationProfileResult Elevation.Profile(ElevationProfileParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/elevation/profile
ModelsExpand Collapse
class ElevationBatchResult:

GeoJSON FeatureCollection of elevation Point Features with 3D coordinates

required IReadOnlyList<ElevationLookupResult> Features

Elevation Point Features for each queried point

required GeoJsonGeometry Geometry
required Coordinates Coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type
One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required Properties Properties
Double ElevationM

Elevation in meters above mean sea level

required Type Type
required Type Type
class ElevationLookupResult:

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

required GeoJsonGeometry Geometry
required Coordinates Coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type
One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required Properties Properties
Double ElevationM

Elevation in meters above mean sea level

required Type Type
class ElevationProfileRequest:

Request body for elevation profile

required GeoJsonGeometry Geometry

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

required Coordinates Coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type
One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
class ElevationProfileResult:

GeoJSON LineString Feature with 3D coordinates representing an elevation profile

required GeoJsonGeometry Geometry
required Coordinates Coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
IReadOnlyList<Double>
IReadOnlyList<IReadOnlyList<Double>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>
IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>
required Type Type
One of the following:
"Point"Point
"LineString"LineString
"Polygon"Polygon
"MultiPoint"MultiPoint
"MultiLineString"MultiLineString
"MultiPolygon"MultiPolygon
required Properties Properties
Double AvgElevationM

Average elevation along profile

Double MaxElevationM

Maximum elevation along profile

Double MinElevationM

Minimum elevation along profile

Double TotalAscentM

Total elevation gain in meters

Double TotalDescentM

Total elevation loss in meters

required Type Type