Skip to content
Plaza Plaza Docs
GuidesBlogPlaygroundDashboard
API Reference
Elevation

Look up elevation at one or more points

elevation.lookup(ElevationLookupParams**kwargs) -> ElevationLookupResult
GET/api/v1/elevation

Look up elevation at one or more points

ParametersExpand Collapse
format: Optional[str]

Response format: json (default), geojson, csv, ndjson

lat: Optional[float]

Latitude (single point)

lng: Optional[float]

Longitude (single point)

locations: Optional[str]

Pipe-separated lng,lat pairs (batch)

output_fields: Optional[str]

Comma-separated property fields to include

output_include: Optional[str]

Extra computed fields: bbox, center

output_precision: Optional[int]

Coordinate decimal precision (1-15, default 7)

ReturnsExpand Collapse
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: Union[List[float], List[List[float]], List[List[List[float]]], List[List[List[List[float]]]]]

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

One of the following:
List[float]

[longitude, latitude] or [longitude, latitude, elevation]

List[List[float]]

Array of [lng, lat] positions

List[List[List[float]]]

Array of linear rings / line strings

List[List[List[List[float]]]]

Array of polygons

type: Literal["Point", "LineString", "Polygon", 3 more]

Geometry type

One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: Properties
elevation_m: float

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

type: Literal["Feature"]

Look up elevation at one or more points

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_lookup_result = client.elevation.lookup()
print(elevation_lookup_result.geometry)
{
  "geometry": {
    "coordinates": [
      2.3522,
      48.8566
    ],
    "type": "Point"
  },
  "properties": {
    "elevation_m": 35.2
  },
  "type": "Feature"
}
Returns Examples
{
  "geometry": {
    "coordinates": [
      2.3522,
      48.8566
    ],
    "type": "Point"
  },
  "properties": {
    "elevation_m": 35.2
  },
  "type": "Feature"
}