X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/141b32f4192819579adbc1388a90ba92d47485e6..381c9395747a04672acba395e0bd14332d1a9db9:/docs/api/Overview.md?ds=sidebyside diff --git a/docs/api/Overview.md b/docs/api/Overview.md index 8bf14c43..a718079d 100644 --- a/docs/api/Overview.md +++ b/docs/api/Overview.md @@ -1,14 +1,14 @@ ### Nominatim API -Nominatim indexes named (or numbered) features with the OSM data set and a subset of other unnamed features (pubs, hotels, churches, etc). +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: * __[/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)