Skip to content
Plaza Plaza Docs
GuidesBlogPlaygroundDashboard
API Reference
Elevation

Look up elevation for multiple coordinates

elevation().batch(ElevationBatchParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : ElevationBatchResult
POST/api/v1/elevation/batch

Look up elevation for multiple coordinates

ParametersExpand Collapse
params: ElevationBatchParams
format: Optional<String>

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

coordinates: List<Coordinate>

Coordinates to look up elevations for (max 50)

lat: Double

Latitude in decimal degrees (-90 to 90)

maximum90
minimum-90
lng: Double

Longitude in decimal degrees (-180 to 180)

maximum180
minimum-180
ReturnsExpand Collapse
class ElevationBatchResult:

GeoJSON FeatureCollection of elevation Point Features with 3D coordinates. Order matches the input coordinates array.

features: List<ElevationLookupResult>

Elevation results in the same order as input coordinates

geometry: GeoJsonGeometry

GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

coordinates: Coordinates

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

One of the following:
List<Double>
List<List<Double>>
List<List<List<Double>>>
List<List<List<List<Double>>>>
type: Type

Geometry type

One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
properties: Properties
elevationM: Double

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

type: Type
type: Type

Look up elevation for multiple coordinates

package com.plazafyi.example

import com.plazafyi.client.PlazaClient
import com.plazafyi.client.okhttp.PlazaOkHttpClient
import com.plazafyi.models.elevation.ElevationBatchParams
import com.plazafyi.models.elevation.ElevationBatchResult

fun main() {
    val client: PlazaClient = PlazaOkHttpClient.fromEnv()

    val params: ElevationBatchParams = ElevationBatchParams.builder()
        .addCoordinate(ElevationBatchParams.Coordinate.builder()
            .lat(48.8566)
            .lng(2.3522)
            .build())
        .addCoordinate(ElevationBatchParams.Coordinate.builder()
            .lat(45.764)
            .lng(4.8357)
            .build())
        .build()
    val elevationBatchResult: ElevationBatchResult = client.elevation().batch(params)
}
{
  "features": [
    {
      "geometry": {
        "coordinates": [
          2.3522,
          48.8566
        ],
        "type": "Point"
      },
      "properties": {
        "elevation_m": 35.2
      },
      "type": "Feature"
    }
  ],
  "type": "FeatureCollection"
}
Returns Examples
{
  "features": [
    {
      "geometry": {
        "coordinates": [
          2.3522,
          48.8566
        ],
        "type": "Point"
      },
      "properties": {
        "elevation_m": 35.2
      },
      "type": "Feature"
    }
  ],
  "type": "FeatureCollection"
}