osrmroute-com Geofencing API

openapi: 3.2.0
info:
  title: OSRMRoute Geofencing 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: Geofencing API
paths:
  /api/1/geofence:
    post:
      tags:
      - Geofencing API
      summary: Geofencing API
      description: The Geofencing API checks, in a single request, which of your zones each point is inside. Define fences as polygons or as a center + radius, then send a batch of points; the response lists the matching fence ids per point. Pure geometry, computed in-house with no rate-dependent upstreams — ideal for delivery zones, alerts and access control.
      operationId: post_geofencing
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              examples:
                success:
                  summary: Illustrative abbreviated response; values vary with input and map data.
                  value:
                    results:
                    - point:
                        lat: 40.3777
                        lng: 49.8516
                      inside:
                      - depot
                    count: 1
                    took: 1
        '400':
          description: Error Codes (HTTP 400)
          content:
            application/json:
              examples:
                invalid:
                  value:
                    error: 'Limits: up to 100 fences and 1000 points 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 / 100 points
      x-request-limits:
      - 'fences: 1–100'
      - 'points: 1–1000'
      - credits = max(1, ceil(points / 100))
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                fences:
                  type: array
                  items: {}
                  description: 'Array of fences: ''{'' id?, polygon:[[lat,lng],...] ''}'' or ''{'' id?, center:[lat,lng], radius_m ''}''. Up to 100.'
                points:
                  type: array
                  items: {}
                  description: Array of [lat,lng] points to test (up to 1000).
                  example:
                  - - 40.3755
                    - 49.8516
                  - - 40.3892
                    - 49.8378
              required:
              - fences
              - points
            example:
              fences:
              - id: zone1
                polygon:
                - - 40.4
                  - 49.85
                - - 40.43
                  - 49.85
                - - 40.43
                  - 49.9
                - - 40.4
                  - 49.9
              points:
              - - 40.41
                - 49.87
              - - 40.5
                - 50.1
components:
  securitySchemes:
    apiKeyQuery:
      type: apiKey
      in: query
      name: key
    bearerAuth:
      type: http
      scheme: bearer