# Elevation

## Look up elevation at one or more points

**get** `/api/v1/elevation`

Look up elevation at one or more points

### Query Parameters

- `lat: optional number`

  Latitude (single point)

- `lng: optional number`

  Longitude (single point)

- `locations: optional string`

  Pipe-separated lng,lat pairs (batch)

### Returns

- `ElevationLookupResult = object { geometry, properties, type }`

  GeoJSON Point Feature with 3D coordinate [lng, lat, elevation] (RFC 7946 §3.1.1)

  - `geometry: GeoJsonGeometry`

    - `coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number`

      GeoJSON coordinates array (nesting depth varies by geometry type)

      - `array of number`

      - `array of array of number`

      - `array of array of array of number`

      - `array of array of array of array of number`

    - `type: "Point" or "LineString" or "Polygon" or 3 more`

      - `"Point"`

      - `"LineString"`

      - `"Polygon"`

      - `"MultiPoint"`

      - `"MultiLineString"`

      - `"MultiPolygon"`

  - `properties: object { elevation_m }`

    - `elevation_m: optional number`

      Elevation in meters above mean sea level

  - `type: "Feature"`

    - `"Feature"`

### Example

```http
curl https://plaza.fyi/api/v1/elevation \
    -H "Authorization: Bearer $PLAZA_API_KEY"
```

## Look up elevation for multiple coordinates

**post** `/api/v1/elevation/batch`

Look up elevation for multiple coordinates

### Body Parameters

- `geometry: GeoJsonGeometry`

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

  - `coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number`

    GeoJSON coordinates array (nesting depth varies by geometry type)

    - `array of number`

    - `array of array of number`

    - `array of array of array of number`

    - `array of array of array of array of number`

  - `type: "Point" or "LineString" or "Polygon" or 3 more`

    - `"Point"`

    - `"LineString"`

    - `"Polygon"`

    - `"MultiPoint"`

    - `"MultiLineString"`

    - `"MultiPolygon"`

### Returns

- `ElevationBatchResult = object { features, type }`

  GeoJSON FeatureCollection of elevation Point Features with 3D coordinates

  - `features: array of ElevationLookupResult`

    Elevation Point Features for each queried point

    - `geometry: GeoJsonGeometry`

      - `coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number`

        GeoJSON coordinates array (nesting depth varies by geometry type)

        - `array of number`

        - `array of array of number`

        - `array of array of array of number`

        - `array of array of array of array of number`

      - `type: "Point" or "LineString" or "Polygon" or 3 more`

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: object { elevation_m }`

      - `elevation_m: optional number`

        Elevation in meters above mean sea level

    - `type: "Feature"`

      - `"Feature"`

  - `type: "FeatureCollection"`

    - `"FeatureCollection"`

### Example

```http
curl https://plaza.fyi/api/v1/elevation/batch \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $PLAZA_API_KEY" \
    -d '{
          "geometry": {
            "coordinates": [
              0
            ],
            "type": "Point"
          }
        }'
```

## Elevation profile along coordinates

**post** `/api/v1/elevation/profile`

Elevation profile along coordinates

### Body Parameters

- `geometry: GeoJsonGeometry`

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

  - `coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number`

    GeoJSON coordinates array (nesting depth varies by geometry type)

    - `array of number`

    - `array of array of number`

    - `array of array of array of number`

    - `array of array of array of array of number`

  - `type: "Point" or "LineString" or "Polygon" or 3 more`

    - `"Point"`

    - `"LineString"`

    - `"Polygon"`

    - `"MultiPoint"`

    - `"MultiLineString"`

    - `"MultiPolygon"`

### Returns

- `ElevationProfileResult = object { geometry, properties, type }`

  GeoJSON LineString Feature with 3D coordinates representing an elevation profile

  - `geometry: GeoJsonGeometry`

    - `coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number`

      GeoJSON coordinates array (nesting depth varies by geometry type)

      - `array of number`

      - `array of array of number`

      - `array of array of array of number`

      - `array of array of array of array of number`

    - `type: "Point" or "LineString" or "Polygon" or 3 more`

      - `"Point"`

      - `"LineString"`

      - `"Polygon"`

      - `"MultiPoint"`

      - `"MultiLineString"`

      - `"MultiPolygon"`

  - `properties: object { avg_elevation_m, max_elevation_m, min_elevation_m, 2 more }`

    - `avg_elevation_m: optional number`

      Average elevation along profile

    - `max_elevation_m: optional number`

      Maximum elevation along profile

    - `min_elevation_m: optional number`

      Minimum elevation along profile

    - `total_ascent_m: optional number`

      Total elevation gain in meters

    - `total_descent_m: optional number`

      Total elevation loss in meters

  - `type: "Feature"`

    - `"Feature"`

### Example

```http
curl https://plaza.fyi/api/v1/elevation/profile \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $PLAZA_API_KEY" \
    -d '{
          "geometry": {
            "coordinates": [
              0
            ],
            "type": "Point"
          }
        }'
```

## Domain Types

### Elevation Batch Result

- `ElevationBatchResult = object { features, type }`

  GeoJSON FeatureCollection of elevation Point Features with 3D coordinates

  - `features: array of ElevationLookupResult`

    Elevation Point Features for each queried point

    - `geometry: GeoJsonGeometry`

      - `coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number`

        GeoJSON coordinates array (nesting depth varies by geometry type)

        - `array of number`

        - `array of array of number`

        - `array of array of array of number`

        - `array of array of array of array of number`

      - `type: "Point" or "LineString" or "Polygon" or 3 more`

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: object { elevation_m }`

      - `elevation_m: optional number`

        Elevation in meters above mean sea level

    - `type: "Feature"`

      - `"Feature"`

  - `type: "FeatureCollection"`

    - `"FeatureCollection"`

### Elevation Lookup Result

- `ElevationLookupResult = object { geometry, properties, type }`

  GeoJSON Point Feature with 3D coordinate [lng, lat, elevation] (RFC 7946 §3.1.1)

  - `geometry: GeoJsonGeometry`

    - `coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number`

      GeoJSON coordinates array (nesting depth varies by geometry type)

      - `array of number`

      - `array of array of number`

      - `array of array of array of number`

      - `array of array of array of array of number`

    - `type: "Point" or "LineString" or "Polygon" or 3 more`

      - `"Point"`

      - `"LineString"`

      - `"Polygon"`

      - `"MultiPoint"`

      - `"MultiLineString"`

      - `"MultiPolygon"`

  - `properties: object { elevation_m }`

    - `elevation_m: optional number`

      Elevation in meters above mean sea level

  - `type: "Feature"`

    - `"Feature"`

### Elevation Profile Request

- `ElevationProfileRequest = object { geometry }`

  Request body for elevation profile

  - `geometry: GeoJsonGeometry`

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

    - `coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number`

      GeoJSON coordinates array (nesting depth varies by geometry type)

      - `array of number`

      - `array of array of number`

      - `array of array of array of number`

      - `array of array of array of array of number`

    - `type: "Point" or "LineString" or "Polygon" or 3 more`

      - `"Point"`

      - `"LineString"`

      - `"Polygon"`

      - `"MultiPoint"`

      - `"MultiLineString"`

      - `"MultiPolygon"`

### Elevation Profile Result

- `ElevationProfileResult = object { geometry, properties, type }`

  GeoJSON LineString Feature with 3D coordinates representing an elevation profile

  - `geometry: GeoJsonGeometry`

    - `coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number`

      GeoJSON coordinates array (nesting depth varies by geometry type)

      - `array of number`

      - `array of array of number`

      - `array of array of array of number`

      - `array of array of array of array of number`

    - `type: "Point" or "LineString" or "Polygon" or 3 more`

      - `"Point"`

      - `"LineString"`

      - `"Polygon"`

      - `"MultiPoint"`

      - `"MultiLineString"`

      - `"MultiPolygon"`

  - `properties: object { avg_elevation_m, max_elevation_m, min_elevation_m, 2 more }`

    - `avg_elevation_m: optional number`

      Average elevation along profile

    - `max_elevation_m: optional number`

      Maximum elevation along profile

    - `min_elevation_m: optional number`

      Minimum elevation along profile

    - `total_ascent_m: optional number`

      Total elevation gain in meters

    - `total_descent_m: optional number`

      Total elevation loss in meters

  - `type: "Feature"`

    - `"Feature"`