Nominatim Status API

openapi: 3.2.0
info:
  title: Nominatim Status API
  description: Nominatim is an open-source search engine for OpenStreetMap data.
  version: 4.5.0
  license:
    name: BSD-2-Clause
    url: https://github.com/osm-search/Nominatim/blob/master/COPYING
  contact:
    name: OpenStreetMap Search Team
    url: https://nominatim.org/
  termsOfService: https://operations.osmfoundation.org/policies/nominatim/
servers:
- url: https://nominatim.openstreetmap.org
  description: Public Nominatim instance operated by the OpenStreetMap Foundation
- url: https://{host}
  description: Self-hosted Nominatim instance
  variables:
    host:
      default: nominatim.example.org
      description: Hostname of a self-hosted Nominatim deployment
tags:
- name: Status
  description: Service and database status reporting.
paths:
  /status:
    get:
      operationId: status
      tags:
      - Status
      summary: Report Service And Database Status
      description: 'Report on the state of the Nominatim service and its underlying

        database. Useful for health checks.'
      parameters:
      - name: format
        in: query
        description: Response format.
        schema:
          type: string
          enum:
          - text
          - json
          default: text
      responses:
        '200':
          description: Service is healthy. JSON response includes data update timestamp and versions.
          content:
            text/plain:
              schema:
                type: string
                example: OK
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '500':
          description: Service or database error (text format only).
          content:
            text/plain:
              schema:
                type: string
                example: 'ERROR: Database connection failed'
components:
  schemas:
    Status:
      type: object
      description: Service and database status.
      properties:
        status:
          type: integer
          description: Numeric status code (0 means OK).
          example: 0
        message:
          type: string
          example: OK
        data_updated:
          type: string
          format: date-time
          example: '2026-05-04T14:47:00+00:00'
        software_version:
          type: string
          example: 4.5.0
        database_version:
          type: string
          example: 4.5.0