Elevation API

key (required)

The key that will identify you to the API.

Get an API key

mode (optional)

• points (default value)

  For each location provided, the corresponding elevation data will be returned.

• path

  Provided locations define a path along which elevation data will be returned at regular intervals.
  The additional parameter samples determines the number of elevation data that must be returned.
  The maximum number of samples per request is 2,048.

• area

  Provided locations define the southwest and northeast corners of an area within which elevation data will be returned at regular intervals.
  The additional parameters rows and columns determine the number of elevation data that must be returned.
  The maximum size of the area (i.e., rows multiplied by columns) per request is 16,384.

locations (required)

Each location must be made up of a latitude (between -80 and 84) and a longitude, separated by a ,
Locations must be separated from each other by a |
The maximum number of locations per request is 512.
The maximum extent of locations per request is 5° latitude by 5° longitude.

format (optional)

• json (default value)

  Elevation data will be returned in JSON format.

• geotiff (only available in area mode)

  Elevation data will be returned in GeoTIFF format.

• kml

  Elevation data will be returned in KML format.

unit (optional)

• meters (default value)

  Elevation data will be returned in meters.

• feet

  Elevation data will be returned in feet.

Status code

• 200 OK: the request was executed successfully.
• 400 Bad Request: the request is malformed.
• 414 Request-URI Too Long: the URL length must be less than 16,385 characters.
• 429 Too Many Requests: the maximum number of 300 requests per minute has been exceeded.
• 402 Payment Required: your request balance is insufficient.
• 500 Internal Server Error: an unexpected error has occurred.

Headers

• Request-Balance: your request balance after the current request has been executed.

Content

• Success example:

  {
      "results": [
          {
              "latitude": 44.690172,
              "longitude": 4.806921,
              "elevation": 114.11919999948627
          },
          {
              "latitude": 42.701059,
              "longitude": 2.896646,
              "elevation": 39.394957439654924
          }
      ]
  }

  In area mode, elevation data will be returned as a 2-dimensional array representing rows and columns.

• Error example:

  {
      "error": {
          "type": "INVALID_API_KEY",
          "message": "The API key is invalid."
      }
  }