docs/api/Overview.md

   1 !!! Attention
   2     The current version of Nominatim implements two different search frontends:
   3     the old PHP frontend and the new Python frontend. They have a very similar
   4     API but differ in some implementation details. These are marked in the
   5     documentation as `[Python-only]` or `[PHP-only]`.
   6
   7     `https://nominatim.openstreetmap.org` implements the **Python frontend**.
   8     So users should refer to the **`[Python-only]`** comments.
   9
  10 This section describes the API V1 of the Nominatim web service. The
  11 service offers the following endpoints:
  12
  13  * __[/search](Search.md)__ - search OSM objects by name or type
  14  * __[/reverse](Reverse.md)__ - search OSM object by their location
  15  * __[/lookup](Lookup.md)__ - look up address details for OSM objects by their ID
  16  * __[/status](Status.md)__ - query the status of the server
  17  * __/deletable__ - list objects that have been deleted in OSM but are held
  18                     back in Nominatim in case the deletion was accidental
  19  * __/polygons__ - list of broken polygons detected by Nominatim
  20  * __[/details](Details.md)__ - show internal details for an object (for debugging only)
  21
  22
  23