osrmroute-com Map Matching API

openapi: 3.2.0
info:
  title: OSRMRoute Map Matching 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: Map Matching API
paths:
  /api/v1/osrm/match/v1/{profile}/{coordinates}:
    get:
      tags:
      - Map Matching API
      summary: Map Matching API
      description: The Map Matching API snaps noisy GPS traces to the real road network. Raw tracking coordinates drift off the road; feed the sequence to this endpoint and it returns a clean, road-aligned path with the roads actually travelled. Essential for fleet telematics, trip reconstruction and turning scattered pings into accurate, logical route data.
      operationId: get_map_matching
      parameters:
      - name: profile
        in: path
        required: true
        description: Transport profile.
        schema:
          type: string
        example: driving
      - name: coordinates
        in: path
        required: true
        description: The sequence of GPS coordinates to snap (lon,lat;lon,lat...)
        schema:
          type: string
        example: 49.8516,40.3755;49.8378,40.3892
      - name: geometries
        in: query
        required: false
        description: 'Geometry format: geojson (GeoJSON object), polyline (encoded string).'
        schema:
          type: string
        example: geojson
      - name: overview
        in: query
        required: false
        description: Geometry precision of the matched route.
        schema:
          type: string
        example: full
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              examples:
                success:
                  summary: Illustrative abbreviated response; values vary with input and map data.
                  value:
                    code: Ok
                    matchings:
                    - distance: 3200
                      duration: 420
                      geometry:
                        type: LineString
                        coordinates:
                        - - 49.8516
                          - 40.3777
                        - - 49.86
                          - 40.4
                      legs:
                      - distance: 3200
                        duration: 420
                        steps: []
                      confidence: 0.97
                    tracepoints:
                    - name: Example road
                      location:
                      - 49.8516
                      - 40.3777
                      distance: 4.2
                    - null
        '400':
          description: Error Codes (HTTP 400)
          content:
            application/json:
              examples:
                InvalidQuery:
                  value:
                    code: InvalidQuery
                    error: Coordinates must be finite longitude,latitude pairs.
        '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:
      - points ≥ 2; points ≤ plan.maxRoutePoints
      - 'tracepoints[]: object | null'
components:
  securitySchemes:
    apiKeyQuery:
      type: apiKey
      in: query
      name: key
    bearerAuth:
      type: http
      scheme: bearer