osrmroute-com Boundary Lookup API

openapi: 3.2.0
info:
  title: OSRMRoute Boundary Lookup 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: Boundary Lookup API
paths:
  /api/1/boundary:
    get:
      tags:
      - Boundary Lookup API
      summary: Boundary Lookup API
      description: The Boundary Lookup API tells you which administrative areas a coordinate falls in — country, state, county, city and district — from self-hosted OSM data. Optionally return the containing boundary as GeoJSON to draw it on a map. Perfect for regional pricing, compliance, territory assignment and analytics.
      operationId: get_boundary
      parameters:
      - name: point
        in: query
        required: true
        description: Coordinate as lat,lng.
        schema:
          type: string
        example: 40.3755,49.8516
      - name: polygon
        in: query
        required: false
        description: Set true to also return the boundary as GeoJSON.
        schema:
          type: boolean
        example: 'false'
      - name: lang
        in: query
        required: false
        description: Language code for place names.
        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:
                    point:
                      lat: 40.3777
                      lng: 49.8516
                    display_name: Baku, Azerbaijan
                    boundary_scope: city
                    country: Azerbaijan
                    countrycode: AZ
                    city: Baku
                    boundary:
                      type: Polygon
                      coordinates:
                      - - - 49.84
                          - 40.37
                        - - 49.87
                          - 40.37
                        - - 49.87
                          - 40.4
                        - - 49.84
                          - 40.37
        '400':
          description: Error Codes (HTTP 400)
          content:
            application/json:
              examples:
                invalid:
                  value:
                    error: Provide a valid coordinate via point=lat,lng or lat= & lon=.
        '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:
                BoundaryCoverageUnavailable:
                  value:
                    code: BoundaryCoverageUnavailable
                    error: Detailed administrative boundary data is not available at this coordinate.
        '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:
      - 'polygon: true | false'
      - 'HTTP 422: BoundaryCoverageUnavailable'
components:
  securitySchemes:
    apiKeyQuery:
      type: apiKey
      in: query
      name: key
    bearerAuth:
      type: http
      scheme: bearer