Skip to content
Plaza Plaza Docs
GuidesBlogPlaygroundDashboard
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 at one or more points
elevation().lookupPost(ElevationLookupPostParamsparams = ElevationLookupPostParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : ElevationLookupResult
POST/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. Order matches the input coordinates array.

features: List<ElevationLookupResult>

Elevation results in the same order as input coordinates

geometry: GeoJsonGeometry

GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

coordinates: Coordinates

Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

One of the following:
List<Double>
List<List<Double>>
List<List<List<Double>>>
List<List<List<List<Double>>>>
type: Type

Geometry 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: Double

Elevation in meters above mean sea level (WGS84 EGM96 geoid)

type: Type
type: Type
class ElevationLookupResult:

GeoJSON Point Feature with a 3D coordinate [lng, lat, elevation] per RFC 7946 §3.1.1. The elevation is also available in properties.elevation_m for convenience.

geometry: GeoJsonGeometry

GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

coordinates: Coordinates

Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

One of the following:
List<Double>
List<List<Double>>
List<List<List<Double>>>
List<List<List<List<Double>>>>
type: Type

Geometry 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: Double

Elevation in meters above mean sea level (WGS84 EGM96 geoid)

type: Type
class ElevationProfileRequest:

Request body for elevation profile along a path. Provide at least 2 coordinates defining the path. Maximum 50 coordinates per request.

coordinates: List<Coordinate>

Path coordinates in order of travel (min 2, max 50)

lat: Double

Latitude in decimal degrees (-90 to 90)

maximum90
minimum-90
lng: Double

Longitude in decimal degrees (-180 to 180)

maximum180
minimum-180
class ElevationProfileResult:

GeoJSON LineString Feature with 3D coordinates [lng, lat, elevation] representing the elevation profile along the input path. Summary statistics are in properties.

geometry: GeoJsonGeometry

GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

coordinates: Coordinates

Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

One of the following:
List<Double>
List<List<Double>>
List<List<List<Double>>>
List<List<List<List<Double>>>>
type: Type

Geometry type

One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
properties: Properties

Elevation profile summary statistics

avgElevationM: Double

Average elevation along the profile in meters

maxElevationM: Double

Maximum elevation along the profile in meters

minElevationM: Double

Minimum elevation along the profile in meters

totalAscentM: Double

Total cumulative elevation gain in meters

totalDescentM: Double

Total cumulative elevation loss in meters

type: Type