X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/7081e2ab66cec624a4e92775f678ba5ab94930f2..HEAD:/docs/api/Overview.md diff --git a/docs/api/Overview.md b/docs/api/Overview.md index 7e822059..30e68cff 100644 --- a/docs/api/Overview.md +++ b/docs/api/Overview.md @@ -1,14 +1,14 @@ -### Nominatim API - -Nominatim indexes named (or numbered) features within the OpenStreetMap (OSM) dataset and a subset of other unnamed features (pubs, hotels, churches, etc). - -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 their ID - * __/status__ - query the status of the server + * __[/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](Details.md)__ - show internal details for an object (for debugging only) + + +