# Elevation ## Look up elevation at one or more points `client.elevation.lookup(ElevationLookupParamsquery?, RequestOptionsoptions?): ElevationLookupResult` **get** `/api/v1/elevation` Look up elevation at one or more points ### Parameters - `query: ElevationLookupParams` - `lat?: number` Latitude (single point) - `lng?: number` Longitude (single point) - `locations?: string` Pipe-separated lng,lat pairs (batch) - `outputFields?: string` Comma-separated property fields to include - `outputInclude?: string` Extra computed fields: bbox, center - `outputPrecision?: number` Coordinate decimal precision (1-15, default 7) ### Returns - `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: Array | Array> | Array>> | Array>>>` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array` - `Array>` - `Array>>` - `Array>>>` - `type: "Point" | "LineString" | "Polygon" | 3 more` Geometry type - `"Point"` - `"LineString"` - `"Polygon"` - `"MultiPoint"` - `"MultiLineString"` - `"MultiPolygon"` - `properties: Properties` - `elevation_m: number` Elevation in meters above mean sea level (WGS84 EGM96 geoid) - `type: "Feature"` - `"Feature"` ### Example ```typescript import Plaza from '@plazafyi/sdk'; const client = new Plaza({ apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted }); const elevationLookupResult = await client.elevation.lookup(); console.log(elevationLookupResult.geometry); ``` #### 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 `client.elevation.lookupPost(ElevationLookupPostParamsparams?, RequestOptionsoptions?): ElevationLookupResult` **post** `/api/v1/elevation` Look up elevation at one or more points ### Parameters - `params: ElevationLookupPostParams` - `lat?: number` Latitude (single point) - `lng?: number` Longitude (single point) - `locations?: string` Pipe-separated lng,lat pairs (batch) - `outputFields?: string` Comma-separated property fields to include - `outputInclude?: string` Extra computed fields: bbox, center - `outputPrecision?: number` Coordinate decimal precision (1-15, default 7) ### Returns - `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: Array | Array> | Array>> | Array>>>` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array` - `Array>` - `Array>>` - `Array>>>` - `type: "Point" | "LineString" | "Polygon" | 3 more` Geometry type - `"Point"` - `"LineString"` - `"Polygon"` - `"MultiPoint"` - `"MultiLineString"` - `"MultiPolygon"` - `properties: Properties` - `elevation_m: number` Elevation in meters above mean sea level (WGS84 EGM96 geoid) - `type: "Feature"` - `"Feature"` ### Example ```typescript import Plaza from '@plazafyi/sdk'; const client = new Plaza({ apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted }); const elevationLookupResult = await client.elevation.lookupPost(); console.log(elevationLookupResult.geometry); ``` #### Response ```json { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "elevation_m": 35.2 }, "type": "Feature" } ``` ## Look up elevation for multiple coordinates `client.elevation.batch(ElevationBatchParamsbody, RequestOptionsoptions?): ElevationBatchResult` **post** `/api/v1/elevation/batch` Look up elevation for multiple coordinates ### Parameters - `body: ElevationBatchParams` - `coordinates: Array` Coordinates to look up elevations for (max 50) - `lat: number` Latitude in decimal degrees (-90 to 90) - `lng: number` Longitude in decimal degrees (-180 to 180) ### Returns - `ElevationBatchResult` GeoJSON FeatureCollection of elevation Point Features with 3D coordinates. Order matches the input coordinates array. - `features: Array` Elevation results in the same order as input coordinates - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Array | Array> | Array>> | Array>>>` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array` - `Array>` - `Array>>` - `Array>>>` - `type: "Point" | "LineString" | "Polygon" | 3 more` Geometry type - `"Point"` - `"LineString"` - `"Polygon"` - `"MultiPoint"` - `"MultiLineString"` - `"MultiPolygon"` - `properties: Properties` - `elevation_m: number` Elevation in meters above mean sea level (WGS84 EGM96 geoid) - `type: "Feature"` - `"Feature"` - `type: "FeatureCollection"` - `"FeatureCollection"` ### Example ```typescript import Plaza from '@plazafyi/sdk'; const client = new Plaza({ apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted }); const elevationBatchResult = await client.elevation.batch({ coordinates: [ { lat: 48.8566, lng: 2.3522 }, { lat: 45.764, lng: 4.8357 }, ], }); console.log(elevationBatchResult.features); ``` #### Response ```json { "features": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "elevation_m": 35.2 }, "type": "Feature" } ], "type": "FeatureCollection" } ``` ## Elevation profile along coordinates `client.elevation.profile(ElevationProfileParamsbody, RequestOptionsoptions?): ElevationProfileResult` **post** `/api/v1/elevation/profile` Elevation profile along coordinates ### Parameters - `body: ElevationProfileParams` - `coordinates: Array` Path coordinates in order of travel (min 2, max 50) - `lat: number` Latitude in decimal degrees (-90 to 90) - `lng: number` Longitude in decimal degrees (-180 to 180) ### Returns - `ElevationProfileResult` GeoJSON LineString Feature with 3D coordinates [lng, lat, elevation] representing the elevation profile along the input path. Summary statistics are in properties. - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Array | Array> | Array>> | Array>>>` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array` - `Array>` - `Array>>` - `Array>>>` - `type: "Point" | "LineString" | "Polygon" | 3 more` Geometry type - `"Point"` - `"LineString"` - `"Polygon"` - `"MultiPoint"` - `"MultiLineString"` - `"MultiPolygon"` - `properties: Properties` Elevation profile summary statistics - `avg_elevation_m: number` Average elevation along the profile in meters - `max_elevation_m: number` Maximum elevation along the profile in meters - `min_elevation_m: number` Minimum elevation along the profile in meters - `total_ascent_m: number` Total cumulative elevation gain in meters - `total_descent_m: number` Total cumulative elevation loss in meters - `type: "Feature"` - `"Feature"` ### Example ```typescript import Plaza from '@plazafyi/sdk'; const client = new Plaza({ apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted }); const elevationProfileResult = await client.elevation.profile({ coordinates: [ { lat: 48.8566, lng: 2.3522 }, { lat: 48.858, lng: 2.34 }, { lat: 48.8584, lng: 2.2945 }, ], }); console.log(elevationProfileResult.geometry); ``` #### 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 - `ElevationBatchResult` GeoJSON FeatureCollection of elevation Point Features with 3D coordinates. Order matches the input coordinates array. - `features: Array` Elevation results in the same order as input coordinates - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Array | Array> | Array>> | Array>>>` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array` - `Array>` - `Array>>` - `Array>>>` - `type: "Point" | "LineString" | "Polygon" | 3 more` Geometry type - `"Point"` - `"LineString"` - `"Polygon"` - `"MultiPoint"` - `"MultiLineString"` - `"MultiPolygon"` - `properties: Properties` - `elevation_m: number` Elevation in meters above mean sea level (WGS84 EGM96 geoid) - `type: "Feature"` - `"Feature"` - `type: "FeatureCollection"` - `"FeatureCollection"` ### Elevation Lookup Result - `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: Array | Array> | Array>> | Array>>>` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array` - `Array>` - `Array>>` - `Array>>>` - `type: "Point" | "LineString" | "Polygon" | 3 more` Geometry type - `"Point"` - `"LineString"` - `"Polygon"` - `"MultiPoint"` - `"MultiLineString"` - `"MultiPolygon"` - `properties: Properties` - `elevation_m: number` Elevation in meters above mean sea level (WGS84 EGM96 geoid) - `type: "Feature"` - `"Feature"` ### Elevation Profile Request - `ElevationProfileRequest` Request body for elevation profile along a path. Provide at least 2 coordinates defining the path. Maximum 50 coordinates per request. - `coordinates: Array` Path coordinates in order of travel (min 2, max 50) - `lat: number` Latitude in decimal degrees (-90 to 90) - `lng: number` Longitude in decimal degrees (-180 to 180) ### Elevation Profile Result - `ElevationProfileResult` GeoJSON LineString Feature with 3D coordinates [lng, lat, elevation] representing the elevation profile along the input path. Summary statistics are in properties. - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Array | Array> | Array>> | Array>>>` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array` - `Array>` - `Array>>` - `Array>>>` - `type: "Point" | "LineString" | "Polygon" | 3 more` Geometry type - `"Point"` - `"LineString"` - `"Polygon"` - `"MultiPoint"` - `"MultiLineString"` - `"MultiPolygon"` - `properties: Properties` Elevation profile summary statistics - `avg_elevation_m: number` Average elevation along the profile in meters - `max_elevation_m: number` Maximum elevation along the profile in meters - `min_elevation_m: number` Minimum elevation along the profile in meters - `total_ascent_m: number` Total cumulative elevation gain in meters - `total_descent_m: number` Total cumulative elevation loss in meters - `type: "Feature"` - `"Feature"`