X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/d2b9493d72a2cdc04863408cc6cd4799561887fa..fe0ade81f59ae7a77fbf4a0493171289969a8184:/docs/api/Overview.md diff --git a/docs/api/Overview.md b/docs/api/Overview.md index 8bf14c43..aac57715 100644 --- a/docs/api/Overview.md +++ b/docs/api/Overview.md @@ -1,14 +1,23 @@ -### Nominatim API +!!! Attention + The current version of Nominatim implements two different search frontends: + the old PHP frontend and the new Python frontend. They have a very similar + API but differ in some implementation details. These are marked in the + documentation as `[Python-only]` or `[PHP-only]`. -Nominatim indexes named (or numbered) features with the OSM data set and a subset of other unnamed features (pubs, hotels, churches, etc). + `https://nominatim.openstreetmap.org` implements the **Python frontend**. + So users should refer to the **`[Python-only]`** comments. -Its API has the following endpoints for querying the data: +This section describes the API V1 of the Nominatim web service. The +service offers the following endpoints: * __[/search](Search.md)__ - search OSM objects by name or type * __[/reverse](Reverse.md)__ - search OSM object by their location - * __[/lookup](Lookup.md)__ - look up address details for OSM objects by thier ID - * __/status__ - query the status of the server + * __[/lookup](Lookup.md)__ - look up address details for OSM objects by their ID + * __[/status](Status.md)__ - query the status of the server * __/deletable__ - list objects that have been deleted in OSM but are held back in Nominatim in case the deletion was accidental * __/polygons__ - list of broken polygons detected by Nominatim - * __/details__ - show internal details for an object (for debugging only) + * __[/details](Details.md)__ - show internal details for an object (for debugging only) + + +