Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference
Elevation

Look up elevation for multiple coordinates

elevation.batch(ElevationBatchParams**kwargs) -> ElevationBatchResult
POST/api/v1/elevation/batch

Look up elevation for multiple coordinates

ParametersExpand Collapse
geometry: GeoJsonGeometryParam

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"
ReturnsExpand 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"]

Look up elevation for multiple coordinates

import os
from plaza import Plaza

client = Plaza(
    api_key=os.environ.get("PLAZA_API_KEY"),  # This is the default and can be omitted
)
elevation_batch_result = client.elevation.batch(
    geometry={
        "coordinates": [0],
        "type": "Point",
    },
)
print(elevation_batch_result.features)
Returns Examples