API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Elevation

Look up elevation at one or more points

elevation.lookup(**kwargs) -> ElevationLookupResult { geometry, properties, type }

GET/api/v1/elevation

Look up elevation for multiple coordinates

elevation.batch(**kwargs) -> ElevationBatchResult { features, type }

POST/api/v1/elevation/batch

Elevation profile along coordinates

elevation.profile(**kwargs) -> ElevationProfileResult { geometry, properties, type }

POST/api/v1/elevation/profile

ModelsExpand Collapse

class 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[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

Array[Float]

Array[Array[Float]]

Array[Array[Array[Float]]]

Array[Array[Array[Array[Float]]]]

type: :Point | :LineString | :Polygon | 3 more

One of the following:

:Point

:LineString

:Polygon

:MultiPoint

:MultiLineString

:MultiPolygon

properties: { elevation_m}

elevation_m: Float

Elevation in meters above mean sea level

type: :Feature

type: :FeatureCollection

class ElevationLookupResult { geometry, properties, type }

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

geometry: GeoJsonGeometry { coordinates, type }

coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

Array[Float]

Array[Array[Float]]

Array[Array[Array[Float]]]

Array[Array[Array[Array[Float]]]]

type: :Point | :LineString | :Polygon | 3 more

One of the following:

:Point

:LineString

:Polygon

:MultiPoint

:MultiLineString

:MultiPolygon

properties: { elevation_m}

elevation_m: Float

Elevation in meters above mean sea level

type: :Feature

class ElevationProfileRequest { geometry }

Request body for elevation profile

geometry: GeoJsonGeometry { coordinates, type }

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

coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

Array[Float]

Array[Array[Float]]

Array[Array[Array[Float]]]

Array[Array[Array[Array[Float]]]]

type: :Point | :LineString | :Polygon | 3 more

One of the following:

:Point

:LineString

:Polygon

:MultiPoint

:MultiLineString

:MultiPolygon

class ElevationProfileResult { geometry, properties, type }

GeoJSON LineString Feature with 3D coordinates representing an elevation profile

geometry: GeoJsonGeometry { coordinates, type }

coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

Array[Float]

Array[Array[Float]]

Array[Array[Array[Float]]]

Array[Array[Array[Array[Float]]]]

type: :Point | :LineString | :Polygon | 3 more

One of the following:

:Point

:LineString

:Polygon

:MultiPoint

:MultiLineString

:MultiPolygon

properties: { avg_elevation_m, max_elevation_m, min_elevation_m, 2 more}

avg_elevation_m: Float

Average elevation along profile

max_elevation_m: Float

Maximum elevation along profile

min_elevation_m: Float

Minimum elevation along profile

total_ascent_m: Float

Total elevation gain in meters

total_descent_m: Float

Total elevation loss in meters

type: :Feature