osrmroute-com Elevation Profile API

openapi: 3.2.0
info:
  title: OSRMRoute Elevation Profile API
  version: 1.1.0
  description: 'OSRMRoute — Maps, Routing, Truck Routing, Search, Road Data, Studio and integration APIs. Use `Authorization: Bearer ` unless an operation documents another flow. Legacy APIs also accept the key query parameter; New geospatial APIs, MCP and private map delivery require Bearer authentication. Mobile challenge/token endpoints use device attestation instead. Coordinates and units are documented per operation: GeoJSON uses longitude,latitude; some legacy and background-job inputs use latitude,longitude. Examples are illustrative, not guaranteed current results. Guides · Mobile Access · MCP · Postman collection.'
  contact:
    name: OSRMRoute Support
    url: https://osrmroute.com/contact
    email: support@osrmroute.com
  termsOfService: https://osrmroute.com/terms
servers:
- url: https://osrmroute.com
security:
- bearerAuth: []
- apiKeyQuery: []
tags:
- name: Elevation Profile API
paths:
  /api/1/elevation/profile:
    post:
      tags:
      - Elevation Profile API
      summary: Elevation Profile API
      description: The Elevation Profile API takes a path — a points array or an encoded polyline — and returns the elevation at every point, plus total ascent, total descent, min/max elevation and cumulative distance. Perfect for cycling, hiking and running apps that need a climb profile. Global SRTM data, so it works anywhere.
      operationId: post_elevation_profile
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              examples:
                success:
                  summary: Illustrative abbreviated response; values vary with input and map data.
                  value:
                    profile:
                    - point:
                        lat: 40.3777
                        lng: 49.8516
                      elevation: null
                      distance: 0
                    - point:
                        lat: 40.4
                        lng: 49.86
                      elevation: null
                      distance: 2590
                    total_ascent: 0
                    total_descent: 0
                    min_elevation: null
                    max_elevation: null
                    distance: 2590
                    unit: meters
                    took: 12
        '400':
          description: Error Codes (HTTP 400)
          content:
            application/json:
              examples:
                invalid:
                  value:
                    error: A maximum of 2000 points is allowed per request.
        '401':
          description: Error Codes (HTTP 401)
          content:
            application/json:
              examples:
                auth:
                  value:
                    error: Invalid API Key
        '402':
          description: Error Codes (HTTP 402)
          content:
            application/json:
              examples:
                balance:
                  value:
                    error: 'Insufficient balance: this request costs 1 credit and your balance is 0 credits. Top up your account to continue.'
        '403':
          description: Error Codes (HTTP 403)
          content:
            application/json:
              examples:
                plan:
                  value:
                    error: This API Key is disabled
        '429':
          description: Error Codes (HTTP 429)
          content:
            application/json:
              examples:
                rate:
                  value:
                    error: 'Rate limit exceeded: more than 60 requests per minute. Please slow down.'
        '500':
          description: Error Codes (HTTP 500)
          content:
            application/json:
              examples:
                upstream:
                  value:
                    error: Internal Server Error
      x-credit-cost: 1 credit / 10 points
      x-request-limits:
      - 'points: 2–2000'
      - credits = max(1, ceil(points / 10))
      - 'elevation: number | null'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                points:
                  type: array
                  items: {}
                  description: Array of [lat,lng] points forming the path (>=2, up to 2000).
                  example:
                  - - 40.3755
                    - 49.8516
                  - - 40.3892
                    - 49.8378
                polyline:
                  type: string
                  description: Encoded polyline as an alternative to points.
            example:
              points:
              - - 40.37
                - 49.85
              - - 40.8
                - 48.9
              - - 41.3
                - 48.05
components:
  securitySchemes:
    apiKeyQuery:
      type: apiKey
      in: query
      name: key
    bearerAuth:
      type: http
      scheme: bearer