API Reference

Elevation

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Look up elevation at one or more points

elevation().lookup(ElevationLookupParamsparams = ElevationLookupParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : ElevationLookupResult

GET/api/v1/elevation

Look up elevation at one or more points

ParametersExpand Collapse

params: ElevationLookupParams

format: Optional<String>

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

lat: Optional<Double>

Latitude (single point)

lng: Optional<Double>

Longitude (single point)

locations: Optional<String>

Pipe-separated lng,lat pairs (batch)

outputFields: Optional<String>

Comma-separated property fields to include

outputInclude: Optional<String>

Extra computed fields: bbox, center

outputPrecision: Optional<Long>

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: 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

Look up elevation at one or more points

Kotlin

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

package com.plazafyi.example

import com.plazafyi.client.PlazaClient
import com.plazafyi.client.okhttp.PlazaOkHttpClient
import com.plazafyi.models.elevation.ElevationLookupParams
import com.plazafyi.models.elevation.ElevationLookupResult

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

    val elevationLookupResult: ElevationLookupResult = client.elevation().lookup()
}

200 example

{
  "geometry": {
    "coordinates": [
      2.3522,
      48.8566
    ],
    "type": "Point"
  },
  "properties": {
    "elevation_m": 35.2
  },
  "type": "Feature"
}

Returns Examples

200 example

{
  "geometry": {
    "coordinates": [
      2.3522,
      48.8566
    ],
    "type": "Point"
  },
  "properties": {
    "elevation_m": 35.2
  },
  "type": "Feature"
}