osrmroute-com Geometry Utilities API

openapi: 3.2.0
info:
  title: OSRMRoute Geometry Utilities 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: Geometry Utilities API
paths:
  /api/1/geometry:
    post:
      tags:
      - Geometry Utilities API
      summary: Geometry Utilities API
      description: 'The Geometry Utilities API is spatial math as a service: distance and bearing between points, a destination from a bearing and distance, midpoints, path length, polygon area, centroids, Douglas–Peucker simplification and Google polyline encode/decode. One endpoint, pick the operation with the op field. Pure computation, works worldwide.'
      operationId: post_geometry
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              examples:
                success:
                  summary: Illustrative abbreviated response; values vary with input and map data.
                  value:
                    op: distance
                    distance: 2590.25
                    unit: meters
        '400':
          description: Error Codes (HTTP 400)
          content:
            application/json:
              examples:
                invalid:
                  value:
                    error: Invalid geometry input for the requested op.
        '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
      x-request-limits:
      - 'op: distance | bearing | destination | midpoint | length | area | centroid | simplify | polyline_encode | polyline_decode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                op:
                  type: string
                  description: 'Operation: distance, bearing, destination, midpoint, length, area, centroid, simplify, polyline_encode or polyline_decode.'
                  example: distance
                from:
                  type: array
                  items: {}
                  description: Start point [lat,lng] (for distance/bearing/destination/midpoint).
                  example: '[lat,lng]'
                to:
                  type: array
                  items: {}
                  description: End point [lat,lng] (for distance/bearing/midpoint).
                  example: '[lat,lng]'
                path:
                  type: array
                  items: {}
                  description: Array of [lat,lng] (for length/simplify/polyline_encode).
                polygon:
                  type: array
                  items: {}
                  description: Array of [lat,lng] ring (for area).
              required:
              - op
            example:
              op: distance
              from:
              - 40.37
              - 49.85
              to:
              - 40.4
              - 49.86
components:
  securitySchemes:
    apiKeyQuery:
      type: apiKey
      in: query
      name: key
    bearerAuth:
      type: http
      scheme: bearer