API Reference

Elevation

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Elevation profile along coordinates

client.Elevation.Profile(ctx, body) (*ElevationProfileResult, error)

POST/api/v1/elevation/profile

Elevation profile along coordinates

ParametersExpand Collapse

body ElevationProfileParams

ElevationProfileRequest param.Field[ElevationProfileRequest]

Request body for elevation profile

ReturnsExpand Collapse

type ElevationProfileResult struct{…}

GeoJSON LineString Feature with 3D coordinates representing an elevation profile

Geometry GeoJsonGeometry

Coordinates GeoJsonGeometryCoordinatesUnion

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

type GeoJsonGeometryCoordinatesArray []float64

type GeoJsonGeometryCoordinatesArray [][]float64

type GeoJsonGeometryCoordinatesArray [][][]float64

type GeoJsonGeometryCoordinatesArray [][][][]float64

Type GeoJsonGeometryType

One of the following:

const GeoJsonGeometryTypePoint GeoJsonGeometryType = "Point"

const GeoJsonGeometryTypeLineString GeoJsonGeometryType = "LineString"

const GeoJsonGeometryTypePolygon GeoJsonGeometryType = "Polygon"

const GeoJsonGeometryTypeMultiPoint GeoJsonGeometryType = "MultiPoint"

const GeoJsonGeometryTypeMultiLineString GeoJsonGeometryType = "MultiLineString"

const GeoJsonGeometryTypeMultiPolygon GeoJsonGeometryType = "MultiPolygon"

Properties ElevationProfileResultProperties

AvgElevationM float64optional

Average elevation along profile

MaxElevationM float64optional

Maximum elevation along profile

MinElevationM float64optional

Minimum elevation along profile

TotalAscentM float64optional

Total elevation gain in meters

TotalDescentM float64optional

Total elevation loss in meters

Type ElevationProfileResultType

Elevation profile along coordinates

Go

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

package main

import (
  "context"
  "fmt"

  "github.com/plazafyi/plaza-go"
  "github.com/plazafyi/plaza-go/option"
)

func main() {
  client := githubcomplazafyiplazago.NewClient(
    option.WithAPIKey("My API Key"),
  )
  elevationProfileResult, err := client.Elevation.Profile(context.TODO(), githubcomplazafyiplazago.ElevationProfileParams{
    ElevationProfileRequest: githubcomplazafyiplazago.ElevationProfileRequestParam{
      Geometry: githubcomplazafyiplazago.F(githubcomplazafyiplazago.GeoJsonGeometryParam{
        Coordinates: githubcomplazafyiplazago.F[githubcomplazafyiplazago.GeoJsonGeometryCoordinatesUnionParam](githubcomplazafyiplazago.GeoJsonGeometryCoordinatesArrayParam([]float64{0.000000})),
        Type: githubcomplazafyiplazago.F(githubcomplazafyiplazago.GeoJsonGeometryTypePoint),
      }),
    },
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", elevationProfileResult.Geometry)
}

Returns Examples