]> git.openstreetmap.org Git - nominatim.git/blob - docs/api/Overview.md
Merge remote-tracking branch 'upstream/master'
[nominatim.git] / docs / api / Overview.md
1 ### Nominatim API
2
3 Nominatim indexes named (or numbered) features within the OpenStreetMap (OSM) dataset and a subset of other unnamed features (pubs, hotels, churches, etc).
4
5 Its API has the following endpoints for querying the data:
6
7  * __[/search](Search.md)__ - search OSM objects by name or type
8  * __[/reverse](Reverse.md)__ - search OSM object by their location
9  * __[/lookup](Lookup.md)__ - look up address details for OSM objects by their ID
10  * __[/status](Status.md)__ - query the status of the server
11  * __/deletable__ - list objects that have been deleted in OSM but are held
12                     back in Nominatim in case the deletion was accidental
13  * __/polygons__ - list of broken polygons detected by Nominatim
14  * __[/details](Details.md)__ - show internal details for an object (for debugging only)