Returns the elevation from a given input coordinate.
Returns the elevation in meters at a given longitude and latitude within the WGS84 coordinate system.
By default the elevation is measured with respect to the Earth's mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.
If the relative
query parameter is set to ellipsoid
, the elevation will be measured with respect to the ellipsoid. This is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.
Note: You cannot permanently store elevations. Please see the Terms of use.
Query parameters
Name | Type | Required | Default value | Description |
---|---|---|---|---|
|
| The longitude of the specified point. | ||
|
| The latitude of the specified point. | ||
|
| The reference position (datum) from which to measure elevation. | ||
|
| The authentication token, used to access the elevation service. | ||
|
| Optional, case-sensitive parameter to specify the format in which responses are given. Can either be |
relativeTo
The reference position (datum) from which to measure elevation. The valid values are:
- meanSeaLevel: The elevation above or below the WGS84 geoid reference surface, which is approximately the mean sea level. It takes into account the local variations in gravity and provides a consistent vertical reference.
- ellipsoid: Ellipsoidal height is measured with respect to an ellipsoid, which is a mathematical model that approximates the shape of the Earth. It does not consider local variations in gravity and is commonly used in GPS positioning.
- Default
- meanSeaLevel
Enumerated values
token
The authentication token, used to access the elevation service.
The token
parameter can be either an API Key or short-lived token.
Alternatively, you can supply a token in the request header with one of the following keys using the "Bearer" scheme:
Authorization
: Bearer <YOUR _TOKEN > X-
Esri- Authorization : Bearer <YOUR _TOKEN >
The provided token
must be created from an ArcGIS Location Platform account and have the necessary premium
privilege to use the elevation service.
Developer guide: To learn more, go to Security and authentication.
f
Optional, case-sensitive parameter to specify the format in which responses are given. Can either be json
or pjson
.
- Default
- json
Enumerated values
Examples
Request
# You can also use wget
curl -X GET https://elevation-api.arcgis.com/arcgis/rest/services/elevation-service/beta/elevation/at-point?lon=-179.99&lat=-85.05 \
-H 'Accept: application/json'
Response
Response to a request for the elevation at a specified point.
{
"elevationInfo": {
"relativeTo": "meanSeaLevel"
},
"result": {
"point": {
"spatialReference": {
"wkid": 4326
},
"x": -117.194769,
"y": 34.057289,
"z": 396
}
}
}
{
"elevationInfo": {
"relativeTo": "meanSeaLevel"
},
"result": {
"point": {
"spatialReference": {
"wkid": 4326
},
"x": 86.925278,
"y": 27.988333,
"z": 8744
}
}
}
{
"elevationInfo": {
"relativeTo": "ellipsoid"
},
"result": {
"point": {
"spatialReference": {
"wkid": 4326
},
"x": -3.1837516,
"y": 51.4822346,
"z": 59
}
}
}
{
"elevationInfo": {
"relativeTo": "ellipsoid"
},
"result": {
"point": {
"spatialReference": {
"wkid": 4326
},
"x": -111.093244,
"y": 45.6830173,
"z": 1452
}
}
}
400 Response
{
"error": {
"code": 400,
"message": "string",
"details": [
"string"
],
"restInfoUrl": "https://elevation-api.arcgis.com/arcgis/rest/info"
}
}
Status | Meaning | Description | Schema |
---|---|---|---|
| Response to a request for the elevation at a specified point. | Inline | |
| Invalid query parameters / Incorrect portal item type. | ||
| Authentication Error. The API key or token is missing, invalid or expired. | ||
| The requested resource cannot be accessed because of incorrect sharing permissions. | ||
| Unknown | An error occurred on the server. |
Response details
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
|
| none | A structure containing human readable metadata about the specified point. | |
|
| none | The reference position (datum) from which to measure elevation. The valid values are:
| |
|
| none | A structure containing a point including an elevation value (defined as Z). | |
| none | A geometry point referring to a location on a map. | ||
|
| none | The spatial reference system the point is relative to. | |
|
| none | The Well-Known ID (WKID) value of the spatial reference. | |
|
| none | The X coordinate which is measured along the east/west axis. | |
|
| none | The Y coordinate which is measured along the north/south axis. | |
|
| none | The Z coordinate represents the vertical position of a point above or below a reference level, such as sea level (in meters, rounded to the nearest meter). |