Skip to content
GuidesPlaygroundDashboard

Look up elevation for multiple coordinates

client.elevation.batch(ElevationBatchParams { geometry } body, RequestOptionsoptions?): ElevationBatchResult { features, type }
POST/api/v1/elevation/batch

Look up elevation for multiple coordinates

ParametersExpand Collapse
body: ElevationBatchParams { geometry }
geometry: GeoJsonGeometry { coordinates, type }

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

coordinates: Array<number> | Array<Array<number>> | Array<Array<Array<number>>> | Array<Array<Array<Array<number>>>>

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
Array<number>
Array<Array<number>>
Array<Array<Array<number>>>
Array<Array<Array<Array<number>>>>
type: "Point" | "LineString" | "Polygon" | 3 more
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
ReturnsExpand Collapse
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<number> | Array<Array<number>> | Array<Array<Array<number>>> | Array<Array<Array<Array<number>>>>

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
Array<number>
Array<Array<number>>
Array<Array<Array<number>>>
Array<Array<Array<Array<number>>>>
type: "Point" | "LineString" | "Polygon" | 3 more
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: Properties { elevation_m }
elevation_m?: number

Elevation in meters above mean sea level

type: "Feature"
type: "FeatureCollection"

Look up elevation for multiple coordinates

import Plaza from '@plazafyi/sdk';

const client = new Plaza({
  apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted
});

const elevationBatchResult = await client.elevation.batch({
  geometry: { coordinates: [0], type: 'Point' },
});

console.log(elevationBatchResult.features);
Returns Examples