Elevation Data

Article
05/22/2024

Note

Bing Maps Elevations API retirement

Bing Maps Elevations API is deprecated and will be retired. Free (Basic) account customers can continue to use Bing Maps Elevations API until June 30th, 2025. Enterprise account customers can continue to use Bing Maps Elevations API until June 30th, 2028. To avoid service disruptions, all implementations using Bing Maps Elevations API will need to be updated to use an alternative solution, such as Create elevation data & services, by the retirement date that applies to your Bing Maps for Enterprise account type.

The response returned by an Elevations URL can contain elevation or sea level offset resource data.

These resources are provided within a common response container. For a description, see Common Response Description.

Elevation and Sea Level Offset Resource Data

JSON	XML	Type	Description
`elevations`	`Elevations`	array of `integers`	A list of elevation values in meters.
`offsets`	`Offsets`	array of `integers`	The difference between sea level models for a set of locations.
`zoomLevel`	`ZoomLevel`	`integer`	The zoom level used to compute the elevation values. Zoom level values are from 1 to 21. A lower value typically means less accurate results because the resolution of the elevation data is less. At lower resolutions, interpolated elevation values use data points that are further apart. The zoom level used depends on the amount of elevation data available in a region and can be lowered when the specified path covers a long distance.

Examples

Elevations Resource

A JSON Response:

{  
   "authenticationResultCode":"ValidCredentials",  
   "brandLogoUri":"http:\/\/dev.virtualearth.net\/Branding\/logo_powered_by.png",  
   "copyright":"Copyright © 2012 Microsoft and its suppliers. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Microsoft Corporation.",  
   "resourceSets":[  
      {  
         "estimatedTotal":1,  
         "resources":[  
            {  
               "__type":"ElevationData:http:\/\/schemas.microsoft.com\/search\/local\/ws\/rest\/v1",  
               "elevations":[1776,1775,1777,1776],  
               "zoomLevel":14  
            }  
         ]  
      }  
   ],  
   "statusCode":200,  
   "statusDescription":"OK",  
   "traceId":"8d57dbeb0bb94e7ca67fd25b4114f5c3"  
}

An XML Response:

<Response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/search/local/ws/rest/v1">  
  <Copyright>  
    Copyright © 2012 Microsoft and its suppliers. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Microsoft Corporation.  
  </Copyright>  
  <BrandLogoUri>http://dev.virtualearth.net/Branding/logo_powered_by.png</BrandLogoUri>  
  <StatusCode>200</StatusCode>  
  <StatusDescription>OK</StatusDescription>  
  <AuthenticationResultCode>ValidCredentials</AuthenticationResultCode>  
  <TraceId>  
    3e6771dbe66045a18f72a787dc8c8deb  
  </TraceId>  
  <ResourceSets>  
    <ResourceSet>  
      <EstimatedTotal>1</EstimatedTotal>  
      <Resources>  
        <ElevationData>  
          <ZoomLevel>14</ZoomLevel>  
          <Elevations>  
            <int>1776</int>  
            <int>1775</int>  
            <int>1777</int>  
            <int>1776</int>  
          </Elevations>  
        </ElevationData>  
      </Resources>  
    </ResourceSet>  
  </ResourceSets>  
</Response>

Sea Level Offset Resource