Google Maps Platform Elevation API

openapi: 3.2.0
info:
  title: Google Maps Platform Elevation API
  description: API Specification for Google Maps Platform
  version: 1.22.3
servers:
- url: https://www.googleapis.com
security:
- ApiKeyAuth: []
tags:
- name: Elevation API
paths:
  /maps/api/elevation/json:
    get:
      operationId: elevation
      servers:
      - url: https://maps.googleapis.com
      tags:
      - Elevation API
      description: 'The Elevation API provides a simple interface to query locations on the earth for elevation data. Additionally, you may request sampled elevation data along paths, allowing you to calculate elevation changes along routes. With the Elevation API, you can develop hiking and biking applications, positioning applications, or low resolution surveying applications.


        Elevation data is available for all locations on the surface of the earth, including depth locations on the ocean floor (which return negative values). In those cases where Google does not possess exact elevation measurements at the precise location you request, the service interpolates and returns an averaged value using the four nearest locations. Elevation values are expressed relative to local mean sea level (LMSL).


        Requests to the Elevation API utilize different parameters based on whether the request is for discrete locations or for an ordered path. For discrete locations, requests for elevation return data on the specific locations passed in the request; for paths, elevation requests are instead sampled along the given path.'
      parameters:
      - $ref: '#/components/parameters/elevation_locations'
      - $ref: '#/components/parameters/elevation_path'
      - $ref: '#/components/parameters/elevation_samples'
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              examples:
                elevation_locations:
                  value:
                    results:
                    - elevation: 1608.637939453125
                      location:
                        lat: 39.7391536
                        lng: -104.9847034
                      resolution: 4.771975994110107
                    status: OK
                elevation_locations_multiple:
                  value:
                    results:
                    - elevation: 1608.637939453125
                      location:
                        lat: 39.7391536
                        lng: -104.9847034
                      resolution: 4.771975994110107
                    - elevation: -52.79492568969727
                      location:
                        lat: 36.455556
                        lng: -116.866667
                      resolution: 19.08790397644043
                    status: OK
                elevation_path:
                  value:
                    results:
                    - elevation: 4411.94189453125
                      location:
                        lat: 36.578581
                        lng: -118.291994
                      resolution: 19.08790397644043
                    - elevation: 1372.8359375
                      location:
                        lat: 36.41150289067028
                        lng: -117.5602607523847
                      resolution: 9.543951988220215
                    - elevation: -84.51690673828125
                      location:
                        lat: 36.23998
                        lng: -116.83171
                      resolution: 9.543951988220215
                    status: OK
                elevation_path_missing_samples:
                  value:
                    results: []
                    status: INVALID_REQUEST
                elevation_invalid_key:
                  value:
                    error_message: 'The provided API key is invalid. '
                    results: []
                    status: REQUEST_DENIED
              schema:
                type: object
                required:
                - status
                - results
                properties:
                  error_message:
                    description: 'When the service returns a status code other than `OK<`, there may be an additional `error_message` field within the response object. This field contains more detailed information about thereasons behind the given status code. This field is not always returned, and its content is subject to change.

                      '
                    type: string
                    example: Invalid request. Invalid 'locations' parameter.
                  status:
                    $ref: '#/components/schemas/ElevationStatus'
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        elevation:
                          type: number
                        resolution:
                          type: number
                        location:
                          $ref: '#/components/schemas/LatLngLiteral'
      summary: Elevation
      x-summary-source: derived
components:
  parameters:
    elevation_samples:
      name: samples
      in: query
      description: Required if path parameter is set.
      schema:
        type: number
      example: 10
    elevation_locations:
      name: locations
      in: query
      style: pipeDelimited
      explode: false
      description: "Positional requests are indicated through use of the locations parameter, indicating elevation requests for the specific locations passed as latitude/longitude values.\n\nThe locations parameter may take the following arguments:\n\n- A single coordinate: `locations=40.714728,-73.998672`\n- An array of coordinates separated using the pipe ('|') character: \n  ```\n  locations=40.714728,-73.998672|-34.397,150.644\n  ```\n- A set of encoded coordinates using the [Encoded Polyline Algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm): \n  ```\n  locations=enc:gfo}EtohhU\n  ```\n\nLatitude and longitude coordinate strings are defined using numerals within a comma-separated text string. For example, \"40.714728,-73.998672\" is a valid locations value. Latitude and longitude values must correspond to a valid location on the face of the earth. Latitudes can take any value between -90 and 90 while longitude values can take any value between -180 and 180. If you specify an invalid latitude or longitude value, your request will be rejected as a bad request.\n\nYou may pass any number of multiple coordinates within an array or encoded polyline, while still constructing a valid URL. Note that when passing multiple coordinates, the accuracy of any returned data may be of lower resolution than when requesting data for a single coordinate.\n"
      example:
      - 35,-100
      - 40,-110
      schema:
        $ref: '#/components/schemas/LatLngArrayString'
    elevation_path:
      name: path
      in: query
      style: pipeDelimited
      explode: false
      description: An array of comma separated `latitude,longitude` strings.
      example:
      - 35,-110
      - 33,-110
      - 31,-110
      schema:
        $ref: '#/components/schemas/LatLngArrayString'
  schemas:
    LatLngArrayString:
      description: An array of comma separated {latitude,longitude} strings.
      title: LatLngArrayString
      example:
      - 35,-100
      - 40,-110
      type: array
      items:
        type: string
        minItems: 2
    ElevationStatus:
      type: string
      title: ElevationStatus
      description: "Status codes returned by service.\n- `OK` indicating the API request was successful.\n- `DATA_NOT_AVAILABLE` indicating that there's no available data for the input locations. \n- `INVALID_REQUEST` indicating the API request was malformed.\n- `OVER_DAILY_LIMIT` indicating any of the following:\n  - The API key is missing or invalid.\n  - Billing has not been enabled on your account.\n  - A self-imposed usage cap has been exceeded.\n  - The provided method of payment is no longer valid (for example, a credit card has expired).\n- `OVER_QUERY_LIMIT` indicating the requestor has exceeded quota.\n- `REQUEST_DENIED` indicating the API did not complete the request.\n- `UNKNOWN_ERROR` indicating an unknown error.\n"
      enum:
      - OK
      - DATA_NOT_AVAILABLE
      - INVALID_REQUEST
      - OVER_DAILY_LIMIT
      - OVER_QUERY_LIMIT
      - REQUEST_DENIED
      - UNKNOWN_ERROR
    LatLngLiteral:
      type: object
      title: LatLngLiteral
      description: An object describing a specific location with Latitude and Longitude in decimal degrees.
      required:
      - lat
      - lng
      properties:
        lat:
          type: number
          description: Latitude in decimal degrees
        lng:
          type: number
          description: Longitude in decimal degrees
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: query
      name: key