Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference

Elevation

Look up elevation at one or more points
client.elevation.lookup(ElevationLookupParams { lat, lng, locations } query?, RequestOptionsoptions?): ElevationLookupResult { geometry, properties, type }
GET/api/v1/elevation
Look up elevation for multiple coordinates
client.elevation.batch(ElevationBatchParams { geometry } body, RequestOptionsoptions?): ElevationBatchResult { features, type }
POST/api/v1/elevation/batch
Elevation profile along coordinates
client.elevation.profile(ElevationProfileParams { geometry } body, RequestOptionsoptions?): ElevationProfileResult { geometry, properties, type }
POST/api/v1/elevation/profile
ModelsExpand Collapse
ElevationBatchResult { features, type }

GeoJSON FeatureCollection of elevation Point Features with 3D coordinates

features: Array<ElevationLookupResult { geometry, properties, type } >

Elevation Point Features for each queried point

geometry: GeoJsonGeometry { coordinates, type }
coordinates: Array<number> | Array<Array<number>> | Array<Array<Array<number>>> | Array<Array<Array<Array<number>>>>

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
Array<number>
Array<Array<number>>
Array<Array<Array<number>>>
Array<Array<Array<Array<number>>>>
type: "Point" | "LineString" | "Polygon" | 3 more
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: Properties { elevation_m }
elevation_m?: number

Elevation in meters above mean sea level

type: "Feature"
type: "FeatureCollection"
ElevationLookupResult { geometry, properties, type }

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

geometry: GeoJsonGeometry { coordinates, type }
coordinates: Array<number> | Array<Array<number>> | Array<Array<Array<number>>> | Array<Array<Array<Array<number>>>>

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
Array<number>
Array<Array<number>>
Array<Array<Array<number>>>
Array<Array<Array<Array<number>>>>
type: "Point" | "LineString" | "Polygon" | 3 more
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: Properties { elevation_m }
elevation_m?: number

Elevation in meters above mean sea level

type: "Feature"
ElevationProfileRequest { geometry }

Request body for elevation profile

geometry: GeoJsonGeometry { coordinates, type }

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

coordinates: Array<number> | Array<Array<number>> | Array<Array<Array<number>>> | Array<Array<Array<Array<number>>>>

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
Array<number>
Array<Array<number>>
Array<Array<Array<number>>>
Array<Array<Array<Array<number>>>>
type: "Point" | "LineString" | "Polygon" | 3 more
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
ElevationProfileResult { geometry, properties, type }

GeoJSON LineString Feature with 3D coordinates representing an elevation profile

geometry: GeoJsonGeometry { coordinates, type }
coordinates: Array<number> | Array<Array<number>> | Array<Array<Array<number>>> | Array<Array<Array<Array<number>>>>

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
Array<number>
Array<Array<number>>
Array<Array<Array<number>>>
Array<Array<Array<Array<number>>>>
type: "Point" | "LineString" | "Polygon" | 3 more
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: Properties { avg_elevation_m, max_elevation_m, min_elevation_m, 2 more }
avg_elevation_m?: number

Average elevation along profile

max_elevation_m?: number

Maximum elevation along profile

min_elevation_m?: number

Minimum elevation along profile

total_ascent_m?: number

Total elevation gain in meters

total_descent_m?: number

Total elevation loss in meters

type: "Feature"