Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference

Elevation

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

GeoJSON FeatureCollection of elevation Point Features with 3D coordinates

features: List<ElevationLookupResult>

Elevation Point Features for each queried point

geometry: GeoJsonGeometry
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
elevationM: Optional<Double>

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)

geometry: GeoJsonGeometry
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
elevationM: Optional<Double>

Elevation in meters above mean sea level

type: Type
class ElevationProfileRequest:

Request body for elevation profile

geometry: GeoJsonGeometry

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

geometry: GeoJsonGeometry
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
avgElevationM: Optional<Double>

Average elevation along profile

maxElevationM: Optional<Double>

Maximum elevation along profile

minElevationM: Optional<Double>

Minimum elevation along profile

totalAscentM: Optional<Double>

Total elevation gain in meters

totalDescentM: Optional<Double>

Total elevation loss in meters

type: Type