Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference
Elevation

Elevation profile along coordinates

POST/api/v1/elevation/profile

Elevation profile along coordinates

Body ParametersJSONExpand Collapse
geometry: GeoJsonGeometry { coordinates, type }

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

coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
array of number
array of array of number
array of array of array of number
array of array of array of array of number
type: "Point" or "LineString" or "Polygon" or 3 more
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
ReturnsExpand Collapse
ElevationProfileResult = object { geometry, properties, type }

GeoJSON LineString Feature with 3D coordinates representing an elevation profile

geometry: GeoJsonGeometry { coordinates, type }
coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
array of number
array of array of number
array of array of array of number
array of array of array of array of number
type: "Point" or "LineString" or "Polygon" or 3 more
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: object { avg_elevation_m, max_elevation_m, min_elevation_m, 2 more }
avg_elevation_m: optional number

Average elevation along profile

max_elevation_m: optional number

Maximum elevation along profile

min_elevation_m: optional number

Minimum elevation along profile

total_ascent_m: optional number

Total elevation gain in meters

total_descent_m: optional number

Total elevation loss in meters

type: "Feature"

Elevation profile along coordinates

curl https://plaza.fyi/api/v1/elevation/profile \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $PLAZA_API_KEY" \
    -d '{
          "geometry": {
            "coordinates": [
              0
            ],
            "type": "Point"
          }
        }'
Returns Examples