osrmroute-com Directions API

openapi: 3.2.0
info:
  title: OSRMRoute Directions 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: Directions API
paths:
  /api/1/directions:
    get:
      tags:
      - Directions API
      summary: Directions API / Alternative Routes API
      description: 'The Directions API returns turn-by-turn navigation between two or more waypoints. Each step comes with human-readable text, distance, duration, maneuver type and the exact location — ready to render in a navigation UI. It supports driving, cycling and walking, plus alternative routes in one call.


        The Alternative Routes API computes up to three genuinely different routes between your points in a single request. Ideal for giving drivers a choice, avoiding a blocked road, or comparing a fast vs. shorter path — each option includes full geometry, distance and duration.'
      operationId: get_directions
      parameters:
      - name: point
        in: query
        required: true
        description: Waypoint as lat,lng. Repeat the parameter for each stop (minimum 2).
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
        example:
        - 40.3777,49.8516
        - 40.4,49.86
      - name: profile
        in: query
        required: false
        description: 'Travel mode: driving, cycling or walking.'
        schema:
          type: string
        example: driving
      - name: alternatives
        in: query
        required: false
        description: Number of alternative routes to also return (0–3).
        schema:
          type: integer
        example: 2
      - name: lang
        in: query
        required: false
        description: Language code for the instruction text.
        schema:
          type: string
        example: en
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              examples:
                success:
                  summary: Illustrative abbreviated response; values vary with input and map data.
                  value:
                    code: Ok
                    profile: driving
                    routes:
                    - distance: 3200
                      duration: 420
                      geometry:
                        type: LineString
                        coordinates:
                        - - 49.8516
                          - 40.3777
                        - - 49.86
                          - 40.4
                      instructions:
                      - text: Continue on Example road
                        type: continue
                        modifier: straight
                        distance: 300
                        duration: 40
                        name: Example road
                        bearing_after: 90
                        location:
                        - 40.3777
                        - 49.8516
                    waypoints:
                    - name: Example road
                      location:
                      - 40.3777
                      - 49.8516
        '400':
          description: Error Codes (HTTP 400)
          content:
            application/json:
              examples:
                invalid:
                  value:
                    error: At least two points must be provided (point=lat,lng repeated).
        '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
        '422':
          description: Error Codes (HTTP 422)
          content:
            application/json:
              examples:
                ProfileNotAvailable:
                  value:
                    code: ProfileNotAvailable
                    error: This travel profile is not available at one or more coordinates. No driving fallback was used.
                NoNearbyRoad:
                  value:
                    code: NoNearbyRoad
                    error: No connected route within 2000 metres of the requested coordinates.
        '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
      x-request-limits:
      - 'point: repeat ≥ 2; count ≤ plan.maxRoutePoints'
      - 'alternatives: 0–3'
components:
  securitySchemes:
    apiKeyQuery:
      type: apiKey
      in: query
      name: key
    bearerAuth:
      type: http
      scheme: bearer