Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference

Elevation

Look up elevation at one or more points
elevation.lookup(ElevationLookupParams**kwargs) -> ElevationLookupResult
GET/api/v1/elevation
Look up elevation for multiple coordinates
elevation.batch(ElevationBatchParams**kwargs) -> ElevationBatchResult
POST/api/v1/elevation/batch
Elevation profile along coordinates
elevation.profile(ElevationProfileParams**kwargs) -> 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: Union[List[float], List[List[float]], List[List[List[float]]], List[List[List[List[float]]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List[float]
List[List[float]]
List[List[List[float]]]
List[List[List[List[float]]]]
type: Literal["Point", "LineString", "Polygon", 3 more]
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: Properties
elevation_m: Optional[float]

Elevation in meters above mean sea level

type: Literal["Feature"]
type: Literal["FeatureCollection"]
class ElevationLookupResult: …

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

geometry: GeoJsonGeometry
coordinates: Union[List[float], List[List[float]], List[List[List[float]]], List[List[List[List[float]]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List[float]
List[List[float]]
List[List[List[float]]]
List[List[List[List[float]]]]
type: Literal["Point", "LineString", "Polygon", 3 more]
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: Properties
elevation_m: Optional[float]

Elevation in meters above mean sea level

type: Literal["Feature"]
class ElevationProfileRequest: …

Request body for elevation profile

geometry: GeoJsonGeometry

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

coordinates: Union[List[float], List[List[float]], List[List[List[float]]], List[List[List[List[float]]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List[float]
List[List[float]]
List[List[List[float]]]
List[List[List[List[float]]]]
type: Literal["Point", "LineString", "Polygon", 3 more]
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
class ElevationProfileResult: …

GeoJSON LineString Feature with 3D coordinates representing an elevation profile

geometry: GeoJsonGeometry
coordinates: Union[List[float], List[List[float]], List[List[List[float]]], List[List[List[List[float]]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List[float]
List[List[float]]
List[List[List[float]]]
List[List[List[List[float]]]]
type: Literal["Point", "LineString", "Polygon", 3 more]
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: Properties
avg_elevation_m: Optional[float]

Average elevation along profile

max_elevation_m: Optional[float]

Maximum elevation along profile

min_elevation_m: Optional[float]

Minimum elevation along profile

total_ascent_m: Optional[float]

Total elevation gain in meters

total_descent_m: Optional[float]

Total elevation loss in meters

type: Literal["Feature"]