docs/api/Overview.md

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