Skip to content
GuidesPlaygroundDashboard

Elevation

Look up elevation at one or more points
ElevationLookupResult elevation().lookup(ElevationLookupParamsparams = ElevationLookupParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/api/v1/elevation
Look up elevation for multiple coordinates
ElevationBatchResult elevation().batch(ElevationBatchParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/api/v1/elevation/batch
Elevation profile along coordinates
ElevationProfileResult elevation().profile(ElevationProfileParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/api/v1/elevation/profile
ModelsExpand Collapse
class ElevationBatchResult:

GeoJSON FeatureCollection of elevation Point Features with 3D coordinates

List<ElevationLookupResult> features

Elevation Point Features for each queried point

Coordinates coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List<double>
List<List<double>>
List<List<List<double>>>
List<List<List<List<double>>>>
Type type
One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
Properties properties
Optional<Double> elevationM

Elevation in meters above mean sea level

Type type
Type type
class ElevationLookupResult:

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

Coordinates coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List<double>
List<List<double>>
List<List<List<double>>>
List<List<List<List<double>>>>
Type type
One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
Properties properties
Optional<Double> elevationM

Elevation in meters above mean sea level

Type type
class ElevationProfileRequest:

Request body for elevation profile

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

Coordinates coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List<double>
List<List<double>>
List<List<List<double>>>
List<List<List<List<double>>>>
Type type
One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
class ElevationProfileResult:

GeoJSON LineString Feature with 3D coordinates representing an elevation profile

Coordinates coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List<double>
List<List<double>>
List<List<List<double>>>
List<List<List<List<double>>>>
Type type
One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
Properties properties
Optional<Double> avgElevationM

Average elevation along profile

Optional<Double> maxElevationM

Maximum elevation along profile

Optional<Double> minElevationM

Minimum elevation along profile

Optional<Double> totalAscentM

Total elevation gain in meters

Optional<Double> totalDescentM

Total elevation loss in meters

Type type