# Elevation ## Look up elevation at one or more points `ElevationLookupResult Elevation.Lookup(ElevationLookupParams?parameters, CancellationTokencancellationToken = default)` **get** `/api/v1/elevation` Look up elevation at one or more points ### Parameters - `ElevationLookupParams parameters` - `Double lat` Latitude (single point) - `Double lng` Longitude (single point) - `string locations` Pipe-separated lng,lat pairs (batch) - `string outputFields` Comma-separated property fields to include - `string outputInclude` Extra computed fields: bbox, center - `Long outputPrecision` Coordinate decimal precision (1-15, default 7) ### Returns - `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. - `required GeoJsonGeometry Geometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `required Coordinates Coordinates` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `IReadOnlyList` - `IReadOnlyList>` - `IReadOnlyList>>` - `IReadOnlyList>>>` - `required Type Type` Geometry type - `"Point"Point` - `"LineString"LineString` - `"Polygon"Polygon` - `"MultiPoint"MultiPoint` - `"MultiLineString"MultiLineString` - `"MultiPolygon"MultiPolygon` - `required Properties Properties` - `required Double ElevationM` Elevation in meters above mean sea level (WGS84 EGM96 geoid) - `required Type Type` - `"Feature"Feature` ### Example ```csharp ElevationLookupParams parameters = new(); var elevationLookupResult = await client.Elevation.Lookup(parameters); Console.WriteLine(elevationLookupResult); ``` #### Response ```json { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "elevation_m": 35.2 }, "type": "Feature" } ``` ## Look up elevation at one or more points `ElevationLookupResult Elevation.LookupPost(ElevationLookupPostParams?parameters, CancellationTokencancellationToken = default)` **post** `/api/v1/elevation` Look up elevation at one or more points ### Parameters - `ElevationLookupPostParams parameters` - `Double lat` Latitude (single point) - `Double lng` Longitude (single point) - `string locations` Pipe-separated lng,lat pairs (batch) - `string outputFields` Comma-separated property fields to include - `string outputInclude` Extra computed fields: bbox, center - `Long outputPrecision` Coordinate decimal precision (1-15, default 7) ### Returns - `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. - `required GeoJsonGeometry Geometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `required Coordinates Coordinates` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `IReadOnlyList` - `IReadOnlyList>` - `IReadOnlyList>>` - `IReadOnlyList>>>` - `required Type Type` Geometry type - `"Point"Point` - `"LineString"LineString` - `"Polygon"Polygon` - `"MultiPoint"MultiPoint` - `"MultiLineString"MultiLineString` - `"MultiPolygon"MultiPolygon` - `required Properties Properties` - `required Double ElevationM` Elevation in meters above mean sea level (WGS84 EGM96 geoid) - `required Type Type` - `"Feature"Feature` ### Example ```csharp ElevationLookupPostParams parameters = new(); var elevationLookupResult = await client.Elevation.LookupPost(parameters); Console.WriteLine(elevationLookupResult); ``` #### Response ```json { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "elevation_m": 35.2 }, "type": "Feature" } ``` ## Look up elevation for multiple coordinates `ElevationBatchResult Elevation.Batch(ElevationBatchParamsparameters, CancellationTokencancellationToken = default)` **post** `/api/v1/elevation/batch` Look up elevation for multiple coordinates ### Parameters - `ElevationBatchParams parameters` - `required IReadOnlyList coordinates` Coordinates to look up elevations for (max 50) - `required Double Lat` Latitude in decimal degrees (-90 to 90) - `required Double Lng` Longitude in decimal degrees (-180 to 180) ### Returns - `class ElevationBatchResult:` GeoJSON FeatureCollection of elevation Point Features with 3D coordinates. Order matches the input coordinates array. - `required IReadOnlyList Features` Elevation results in the same order as input coordinates - `required GeoJsonGeometry Geometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `required Coordinates Coordinates` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `IReadOnlyList` - `IReadOnlyList>` - `IReadOnlyList>>` - `IReadOnlyList>>>` - `required Type Type` Geometry type - `"Point"Point` - `"LineString"LineString` - `"Polygon"Polygon` - `"MultiPoint"MultiPoint` - `"MultiLineString"MultiLineString` - `"MultiPolygon"MultiPolygon` - `required Properties Properties` - `required Double ElevationM` Elevation in meters above mean sea level (WGS84 EGM96 geoid) - `required Type Type` - `"Feature"Feature` - `required Type Type` - `"FeatureCollection"FeatureCollection` ### Example ```csharp ElevationBatchParams parameters = new() { Coordinates = [ new() { Lat = 48.8566, Lng = 2.3522, }, new() { Lat = 45.764, Lng = 4.8357, }, ], }; var elevationBatchResult = await client.Elevation.Batch(parameters); Console.WriteLine(elevationBatchResult); ``` #### Response ```json { "features": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "elevation_m": 35.2 }, "type": "Feature" } ], "type": "FeatureCollection" } ``` ## Elevation profile along coordinates `ElevationProfileResult Elevation.Profile(ElevationProfileParamsparameters, CancellationTokencancellationToken = default)` **post** `/api/v1/elevation/profile` Elevation profile along coordinates ### Parameters - `ElevationProfileParams parameters` - `required IReadOnlyList coordinates` Path coordinates in order of travel (min 2, max 50) - `required Double Lat` Latitude in decimal degrees (-90 to 90) - `required Double Lng` Longitude in decimal degrees (-180 to 180) ### Returns - `class ElevationProfileResult:` GeoJSON LineString Feature with 3D coordinates [lng, lat, elevation] representing the elevation profile along the input path. Summary statistics are in properties. - `required GeoJsonGeometry Geometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `required Coordinates Coordinates` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `IReadOnlyList` - `IReadOnlyList>` - `IReadOnlyList>>` - `IReadOnlyList>>>` - `required Type Type` Geometry type - `"Point"Point` - `"LineString"LineString` - `"Polygon"Polygon` - `"MultiPoint"MultiPoint` - `"MultiLineString"MultiLineString` - `"MultiPolygon"MultiPolygon` - `required Properties Properties` Elevation profile summary statistics - `required Double AvgElevationM` Average elevation along the profile in meters - `required Double MaxElevationM` Maximum elevation along the profile in meters - `required Double MinElevationM` Minimum elevation along the profile in meters - `required Double TotalAscentM` Total cumulative elevation gain in meters - `required Double TotalDescentM` Total cumulative elevation loss in meters - `required Type Type` - `"Feature"Feature` ### Example ```csharp ElevationProfileParams parameters = new() { Coordinates = [ new() { Lat = 48.8566, Lng = 2.3522, }, new() { Lat = 48.858, Lng = 2.34, }, new() { Lat = 48.8584, Lng = 2.2945, }, ], }; var elevationProfileResult = await client.Elevation.Profile(parameters); Console.WriteLine(elevationProfileResult); ``` #### Response ```json { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "avg_elevation_m": 67.8, "max_elevation_m": 155.3, "min_elevation_m": 28.1, "total_ascent_m": 127.4, "total_descent_m": 89.2 }, "type": "Feature" } ``` ## Domain Types ### Elevation Batch Result - `class ElevationBatchResult:` GeoJSON FeatureCollection of elevation Point Features with 3D coordinates. Order matches the input coordinates array. - `required IReadOnlyList Features` Elevation results in the same order as input coordinates - `required GeoJsonGeometry Geometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `required Coordinates Coordinates` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `IReadOnlyList` - `IReadOnlyList>` - `IReadOnlyList>>` - `IReadOnlyList>>>` - `required Type Type` Geometry type - `"Point"Point` - `"LineString"LineString` - `"Polygon"Polygon` - `"MultiPoint"MultiPoint` - `"MultiLineString"MultiLineString` - `"MultiPolygon"MultiPolygon` - `required Properties Properties` - `required Double ElevationM` Elevation in meters above mean sea level (WGS84 EGM96 geoid) - `required Type Type` - `"Feature"Feature` - `required Type Type` - `"FeatureCollection"FeatureCollection` ### Elevation Lookup Result - `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. - `required GeoJsonGeometry Geometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `required Coordinates Coordinates` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `IReadOnlyList` - `IReadOnlyList>` - `IReadOnlyList>>` - `IReadOnlyList>>>` - `required Type Type` Geometry type - `"Point"Point` - `"LineString"LineString` - `"Polygon"Polygon` - `"MultiPoint"MultiPoint` - `"MultiLineString"MultiLineString` - `"MultiPolygon"MultiPolygon` - `required Properties Properties` - `required Double ElevationM` Elevation in meters above mean sea level (WGS84 EGM96 geoid) - `required Type Type` - `"Feature"Feature` ### Elevation Profile Request - `class ElevationProfileRequest:` Request body for elevation profile along a path. Provide at least 2 coordinates defining the path. Maximum 50 coordinates per request. - `required IReadOnlyList Coordinates` Path coordinates in order of travel (min 2, max 50) - `required Double Lat` Latitude in decimal degrees (-90 to 90) - `required Double Lng` Longitude in decimal degrees (-180 to 180) ### Elevation Profile Result - `class ElevationProfileResult:` GeoJSON LineString Feature with 3D coordinates [lng, lat, elevation] representing the elevation profile along the input path. Summary statistics are in properties. - `required GeoJsonGeometry Geometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `required Coordinates Coordinates` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `IReadOnlyList` - `IReadOnlyList>` - `IReadOnlyList>>` - `IReadOnlyList>>>` - `required Type Type` Geometry type - `"Point"Point` - `"LineString"LineString` - `"Polygon"Polygon` - `"MultiPoint"MultiPoint` - `"MultiLineString"MultiLineString` - `"MultiPolygon"MultiPolygon` - `required Properties Properties` Elevation profile summary statistics - `required Double AvgElevationM` Average elevation along the profile in meters - `required Double MaxElevationM` Maximum elevation along the profile in meters - `required Double MinElevationM` Minimum elevation along the profile in meters - `required Double TotalAscentM` Total cumulative elevation gain in meters - `required Double TotalDescentM` Total cumulative elevation loss in meters - `required Type Type` - `"Feature"Feature`