Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference
Elevation

Elevation profile along coordinates

ElevationProfileResult elevation().profile(ElevationProfileParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/api/v1/elevation/profile

Elevation profile along coordinates

ParametersExpand Collapse
ElevationProfileParams params
ElevationProfileRequest elevationProfileRequest

Request body for elevation profile

ReturnsExpand Collapse
class ElevationProfileResult:

GeoJSON LineString Feature with 3D coordinates representing an elevation profile

Coordinates coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List<double>
List<List<double>>
List<List<List<double>>>
List<List<List<List<double>>>>
Type type
One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
Properties properties
Optional<Double> avgElevationM

Average elevation along profile

Optional<Double> maxElevationM

Maximum elevation along profile

Optional<Double> minElevationM

Minimum elevation along profile

Optional<Double> totalAscentM

Total elevation gain in meters

Optional<Double> totalDescentM

Total elevation loss in meters

Type type

Elevation profile along coordinates

package com.plazafyi.example;

import com.plazafyi.client.PlazaClient;
import com.plazafyi.client.okhttp.PlazaOkHttpClient;
import com.plazafyi.models.GeoJsonGeometry;
import com.plazafyi.models.elevation.ElevationProfileParams;
import com.plazafyi.models.elevation.ElevationProfileRequest;
import com.plazafyi.models.elevation.ElevationProfileResult;
import java.util.List;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        PlazaClient client = PlazaOkHttpClient.fromEnv();

        ElevationProfileRequest params = ElevationProfileRequest.builder()
            .geometry(GeoJsonGeometry.builder()
                .coordinatesOfNumber(List.of(0.0))
                .type(GeoJsonGeometry.Type.POINT)
                .build())
            .build();
        ElevationProfileResult elevationProfileResult = client.elevation().profile(params);
    }
}
Returns Examples