osrmroute-com Matrix API

openapi: 3.2.0
info:
  title: OSRMRoute Matrix 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: Matrix API
paths:
  /api/v1/osrm/table/v1/{profile}/{coordinates}:
    get:
      tags:
      - Matrix API
      summary: Matrix API
      description: The Matrix API calculates travel times and distances between origins and destinations in one request. It supports optimization, dispatch and driver selection. Limits depend on your plan; processing time varies by region, graph cache and matrix size. Validate your expected workload before production.
      operationId: get_matrix
      parameters:
      - name: profile
        in: path
        required: true
        description: Transport profile (driving, cycling, walking).
        schema:
          type: string
        example: driving
      - name: coordinates
        in: path
        required: true
        description: 'Matrix points. Format: lon,lat;lon,lat;lon,lat...'
        schema:
          type: string
        example: 49.8516,40.3755;49.8378,40.3892
      - name: annotations
        in: query
        required: false
        description: 'Data to compute: duration (time), distance, or both.'
        schema:
          type: string
        example: duration
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              examples:
                success:
                  summary: Illustrative abbreviated response; values vary with input and map data.
                  value:
                    code: Ok
                    durations:
                    - - 0
                      - 420
                    - - 430
                      - 0
                    distances:
                    - - 0
                      - 3200
                    - - 3300
                      - 0
                    sources:
                    - name: Example road
                      location:
                      - 49.8516
                      - 40.3777
                      distance: 4.2
                    - name: Second road
                      location:
                      - 49.86
                      - 40.4
                      distance: 3
                    destinations:
                    - name: Example road
                      location:
                      - 49.8516
                      - 40.3777
                      distance: 4.2
                    - name: Second road
                      location:
                      - 49.86
                      - 40.4
                      distance: 3
        '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.
                UnreachablePoints:
                  value:
                    code: UnreachablePoints
                    error: Some locations are disconnected in this road network.
        '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 cells
      x-request-limits:
      - points ≥ 2; points ≤ plan.maxRoutePoints
      - cells = sources × destinations
      - credits = max(1, ceil(cells / 10))
components:
  securitySchemes:
    apiKeyQuery:
      type: apiKey
      in: query
      name: key
    bearerAuth:
      type: http
      scheme: bearer