Skip to content
Plaza Plaza Docs
GuidesBlogPlaygroundDashboard
API Reference

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

List<ElevationLookupResult> features

Elevation results in the same order as input coordinates

GeoJsonGeometry geometry

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
double elevationM

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.

GeoJsonGeometry geometry

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
double elevationM

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.

List<Coordinate> coordinates

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

double lat

Latitude in decimal degrees (-90 to 90)

maximum90
minimum-90
double lng

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.

GeoJsonGeometry geometry

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

double avgElevationM

Average elevation along the profile in meters

double maxElevationM

Maximum elevation along the profile in meters

double minElevationM

Minimum elevation along the profile in meters

double totalAscentM

Total cumulative elevation gain in meters

double totalDescentM

Total cumulative elevation loss in meters

Type type