docs/api/Lookup.md

   1 ## Address lookup
   2
   3 Lookup the address of one or multiple OSM objects like node, way or relation.
   4
   5 ### Parameters
   6 ```
   7   https://nominatim.openstreetmap.org/lookup?<query>
   8 ```
   9
  10 * `format=[xml|json]`
  11
  12     * Output format
  13
  14 * `json_callback=<string>`
  15
  16     * Wrap json output in a callback function (JSONP) i.e. `<string>(<json>)`
  17
  18 * `accept-language=<browser language string>`
  19
  20     * Preferred language order for showing search results, overrides the value specified in the "Accept-Language" HTTP header.
  21     * Either uses standard rfc2616 accept-language string or a simple comma separated list of language codes.
  22
  23 * `osm_ids=[N|W|R]<value>,…,[N|W|R]<value`
  24     * A list of up to 50 specific osm node, way or relations ids to return the addresses for
  25
  26 * `addressdetails=[0|1]`
  27     * defaults to 0
  28     * Include a breakdown of the address into elements
  29
  30 * `email=<valid email address>`
  31
  32     * 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.
  33     * 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.
  34
  35 * `extratags=1`
  36     * Include additional information in the result if available, e.g. wikipedia link, opening hours.
  37
  38 * `namedetails=1`
  39     * Include a list of alternative names in the results.
  40     * These may include language variants, references, operator and brand.
  41
  42 ### Example
  43
  44 * [https://nominatim.openstreetmap.org/lookup?osm_ids=R146656,W104393803,N240109189](https://nominatim.openstreetmap.org/lookup?osm_ids=R146656,W104393803,N240109189)
  45
  46 ```xml
  47   <lookupresults timestamp="Mon, 29 Jun 15 18:01:33 +0000" attribution="Data © OpenStreetMap contributors, ODbL 1.0. https://www.openstreetmap.org/copyright" querystring="R146656,W104393803,N240109189" polygon="false">
  48     <place place_id="127761056" osm_type="relation" osm_id="146656" place_rank="16" lat="53.4791466" lon="-2.2447445" display_name="Manchester, Greater Manchester, North West England, England, United Kingdom" class="boundary" type="administrative" importance="0.704893333438333">
  49       <city>Manchester</city>
  50       <county>Greater Manchester</county>
  51       <state_district>North West England</state_district>
  52       <state>England</state>
  53       <country>United Kingdom</country>
  54       <country_code>gb</country_code>
  55     </place>
  56     <place place_id="77769745" osm_type="way" osm_id="104393803" place_rank="30" lat="52.5162024" lon="13.3777343363579" display_name="Brandenburg Gate, 1, Pariser Platz, Mitte, Berlin, 10117, Germany" class="tourism" type="attraction" importance="0.443472858361592">
  57       <attraction>Brandenburg Gate</attraction>
  58       <house_number>1</house_number>
  59       <pedestrian>Pariser Platz</pedestrian>
  60       <suburb>Mitte</suburb>
  61       <city_district>Mitte</city_district>
  62       <city>Berlin</city>
  63       <state>Berlin</state>
  64       <postcode>10117</postcode>
  65       <country>Germany</country>
  66       <country_code>de</country_code>
  67     </place>
  68     <place place_id="2570600569" osm_type="node" osm_id="240109189" place_rank="15" lat="52.5170365" lon="13.3888599" display_name="Berlin, Germany" class="place" type="city" importance="0.822149797630868">
  69       <city>Berlin</city>
  70       <state>Berlin</state>
  71       <country>Germany</country>
  72       <country_code>de</country_code>
  73     </place>
  74   </lookupresults>
  75 ```