osrmroute-com Batch Geocoding API

openapi: 3.2.0
info:
  title: OSRMRoute Batch Geocoding 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: Batch Geocoding API
paths:
  /api/1/geocode/batch:
    post:
      tags:
      - Batch Geocoding API
      summary: Batch Geocoding API
      description: The Batch Geocoding API turns a list of address strings into coordinates in one call — up to 100 per request. Results are returned in the same order as the input, each with the best matches, so it slots neatly into data pipelines, spreadsheet imports and one-off migrations. Photon powers matching, with a Nominatim fallback for messy input.
      operationId: post_batch_geocoding
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              examples:
                success:
                  summary: Illustrative abbreviated response; values vary with input and map data.
                  value:
                    results:
                    - query: Baku
                      hits:
                      - name: Nizami Street
                        city: Baku
                        country: Azerbaijan
                        countrycode: AZ
                        point:
                          lat: 40.3777
                          lng: 49.8516
                    count: 1
                    took: 12
        '400':
          description: Error Codes (HTTP 400)
          content:
            application/json:
              examples:
                invalid:
                  value:
                    error: A maximum of 100 queries can be geocoded per batch 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 / query
      x-request-limits:
      - 'queries: 1–100'
      - 'limit: 1–5 / query'
      - credits = queries.length
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                queries:
                  type: array
                  items: {}
                  description: Array of address strings to geocode (max 100).
                lang:
                  type: string
                  description: Language code for result labels.
                  example: en
                limit:
                  type: integer
                  description: Maximum matches to return per query (1–5).
                  example: 5
              required:
              - queries
            example:
              queries:
              - Nizami küçəsi 10
              - 28 May, Bakı
              lang: az
components:
  securitySchemes:
    apiKeyQuery:
      type: apiKey
      in: query
      name: key
    bearerAuth:
      type: http
      scheme: bearer