X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/1787892d32351988231a60b71900c6a623609c54..403e6f7e5c9aaeee6de0aefe76bdcbdb997cf108:/docs/api/Lookup.md diff --git a/docs/api/Lookup.md b/docs/api/Lookup.md index 3b6472ad..e91c1770 100644 --- a/docs/api/Lookup.md +++ b/docs/api/Lookup.md @@ -1,51 +1,100 @@ -## Address lookup +# Address lookup -Lookup the address of one or multiple OSM objects like node, way or relation. +The lookup API allows to query the address and other details of one or +multiple OSM objects like node, way or relation. + +## Parameters + +The lookup API has the following format: -### Parameters ``` - https://nominatim.openstreetmap.org/lookup? + https://nominatim.openstreetmap.org/lookup?osm_ids=[N|W|R],…,…,& ``` -* `format=[xml|json]` +`osm_ids` is mandatory and must contain a comma-separated list of OSM ids each +prefixed with its type, one of node(N), way(W) or relation(R). Up to 50 ids +can be queried at the same time. + +Additional optional parameters are explained below. + +### Output format - * Output format +* `format=[xml|json|jsonv2|geojson|geocodejson]` + +See [Place Output Formats](Output.md) for details on each format. (Default: xml) * `json_callback=` - * Wrap json output in a callback function (JSONP) i.e. `()` +Wrap JSON output in a callback function (JSONP) i.e. `()`. +Only has an effect for JSON output formats. + +### Output details + +* `addressdetails=[0|1]` + +Include a breakdown of the address into elements. (Default: 0) + + +* `extratags=[0|1]` + +Include additional information in the result if available, +e.g. wikipedia link, opening hours. (Default: 0) + + +* `namedetails=[0|1]` + +Include a list of alternative names in the results. These may include +language variants, references, operator and brand. (Default: 0) + + +### Language of results * `accept-language=` - * Preferred language order for showing search results, overrides the value specified in the "Accept-Language" HTTP header. - * Either uses standard rfc2616 accept-language string or a simple comma separated list of language codes. +Preferred language order for showing search results, overrides the value +specified in the "Accept-Language" HTTP header. +Either use a standard RFC2616 accept-language string or a simple +comma-separated list of language codes. -* `osm_ids=[N|W|R],…,[N|W|R]` - * If you are making large numbers of request please include a valid email address or alternatively include your email address as part of the User-Agent string. - * This information will be kept confidential and only used to contact you in the event of a problem, see [Usage Policy](https://operations.osmfoundation.org/policies/nominatim/) for more details. +If you are making large numbers of request please include an appropriate email +address to identify your requests. See Nominatim's [Usage Policy](https://operations.osmfoundation.org/policies/nominatim/) for more details. + +* `debug=[0|1]` -* `extratags=1` - * Include additional information in the result if available, e.g. wikipedia link, opening hours. +Output assorted developer debug information. Data on internals of Nominatim's +"Search Loop" logic, and SQL queries. The output is (rough) HTML format. +This overrides the specified machine readable format. (Default: 0) -* `namedetails=1` - * Include a list of alternative names in the results. - * These may include language variants, references, operator and brand. -### Example +## Examples -* [https://nominatim.openstreetmap.org/lookup?osm_ids=R146656,W104393803,N240109189](https://nominatim.openstreetmap.org/lookup?osm_ids=R146656,W104393803,N240109189) +##### XML + +[https://nominatim.openstreetmap.org/lookup?osm_ids=R146656,W104393803,N240109189](https://nominatim.openstreetmap.org/lookup?osm_ids=R146656,W50637691,N240109189) ```xml - - + + Manchester Greater Manchester North West England @@ -53,23 +102,72 @@ Lookup the address of one or multiple OSM objects like node, way or relation. United Kingdom gb - - Brandenburg Gate - 1 - Pariser Platz - Mitte - Mitte - Berlin - Berlin - 10117 + + Brandenburger Tor + Brandenburger Straße + Historische Innenstadt + Potsdam + Brandenburg + 14467 Germany de - + Berlin Berlin + 10178 Germany de ``` + +##### JSON with extratags + +[https://nominatim.openstreetmap.org/lookup?osm_ids=W50637691&format=json&extratags=1](https://nominatim.openstreetmap.org/lookup?osm_ids=W50637691&format=json&extratags=1) + +```json +[ + { + "place_id": 115462561, + "licence": "Data © OpenStreetMap contributors, ODbL 1.0. https://osm.org/copyright", + "osm_type": "way", + "osm_id": 50637691, + "boundingbox": [ + "52.3994612", + "52.3996426", + "13.0479574", + "13.0481754" + ], + "lat": "52.399550700000006", + "lon": "13.048066846939687", + "display_name": "Brandenburger Tor, Brandenburger Straße, Historische Innenstadt, Innenstadt, Potsdam, Brandenburg, 14467, Germany", + "class": "tourism", + "type": "attraction", + "importance": 0.2940287400552381, + "address": { + "tourism": "Brandenburger Tor", + "road": "Brandenburger Straße", + "suburb": "Historische Innenstadt", + "city": "Potsdam", + "state": "Brandenburg", + "postcode": "14467", + "country": "Germany", + "country_code": "de" + }, + "extratags": { + "image": "http://commons.wikimedia.org/wiki/File:Potsdam_brandenburger_tor.jpg", + "heritage": "4", + "wikidata": "Q695045", + "architect": "Carl von Gontard;Georg Christian Unger", + "wikipedia": "de:Brandenburger Tor (Potsdam)", + "wheelchair": "yes", + "description": "Kleines Brandenburger Tor in Potsdam", + "heritage:website": "http://www.bldam-brandenburg.de/images/stories/PDF/DML%202012/04-p-internet-13.pdf", + "heritage:operator": "bldam", + "architect:wikidata": "Q68768;Q95223", + "year_of_construction": "1771" + } + } +] +```