docs/api/Details.md

   1 # Place details
   2
   3 Lookup details about a single place by id. The default output is HTML for debugging search logic and results.
   4
   5 **The details page (including JSON output) exists for debugging only and must not be downloaded automatically**, see [Nominatim Usage Policy](https://operations.osmfoundation.org/policies/nominatim/).
   6
   7
   8 ## Parameters
   9
  10 The details API supports the following two request formats:
  11
  12 ```
  13   https://nominatim.openstreetmap.org/details?osmtype=[N|W|R]&osmid=<value>&class=<value>
  14 ```
  15
  16 `osmtype` and `osmid` are required parameter. The type is one of node (N), way (W)
  17 or relation (R). The id must be a number. The `class` parameter is optional and
  18 allows to distinguish between entries, when the corresponding OSM object has more
  19 than one main tag. For example, when a place is tagged with `tourism=hotel` and
  20 `amenity=restaurant`, there will be two place entries in Nominatim, one for a
  21 restaurant, one for a hotel. You need to specify `class=tourism` or `class=amentity`
  22 to get exactly the one you want. If there are multiple places in the database
  23 but the `class` parameter is left out, then one of the places will be chosen
  24 at random and displayed.
  25
  26 ```
  27   https://nominatim.openstreetmap.org/details?place_id=<value>
  28 ```
  29
  30 Placeids are assigned sequentially during Nominatim data import. The id for a place is different between Nominatim installation (servers) and changes when data gets reimported. Therefore it can't be used as permanent id and shouldn't be used in bug reports.
  31
  32
  33 Additional optional parameters are explained below.
  34
  35 ### Output format
  36
  37 * `format=[html|json]`
  38
  39 See [Place Output Formats](Output.md) for details on each format. (Default: html)
  40
  41 * `json_callback=<string>`
  42
  43 Wrap JSON output in a callback function (JSONP) i.e. `<string>(<json>)`.
  44 Only has an effect for JSON output formats.
  45
  46 * `pretty=[0|1]`
  47
  48 For JSON output will add indentation to make it more human-readable. (Default: 0)
  49
  50
  51 ### Output details
  52
  53 * `addressdetails=[0|1]`
  54
  55 Include a breakdown of the address into elements. (Default for JSON: 0, for HTML: 1)
  56
  57 * `keywords=[0|1]`
  58
  59 Include a list of name keywords and address keywords (word ids). (Default: 0)
  60
  61 * `linkedplaces=[0|1]`
  62
  63 Include details of places higher in the address hierarchy. E.g. for a street this is usually the city, state, postal code, country. (Default: 1)
  64
  65 * `hierarchy=[0|1]`
  66
  67 Include details of places lower in the address hierarchy. E.g. for a city this usually a list of streets, suburbs, rivers. (Default for JSON: 0, for HTML: 1)
  68
  69 * `group_hierarchy=[0|1]`
  70
  71 For JSON output will group the places by type. (Default: 0)
  72
  73 * `polygon_geojson=[0|1]`
  74
  75 Include geometry of result. (Default for JSON: 0, for HTML: 1)
  76
  77 ### Language of results
  78
  79 * `accept-language=<browser language string>`
  80
  81 Preferred language order for showing result, overrides the value
  82 specified in the "Accept-Language" HTTP header.
  83 Either use a standard RFC2616 accept-language string or a simple
  84 comma-separated list of language codes.
  85
  86
  87 ## Examples
  88
  89 ##### HTML
  90
  91 [https://nominatim.openstreetmap.org/details.php?osmtype=W&osmid=38210407](https://nominatim.openstreetmap.org/details.php?osmtype=W&osmid=38210407)
  92
  93 ##### JSON
  94
  95 [https://nominatim.openstreetmap.org/details.php?osmtype=W&osmid=38210407&format=json](https://nominatim.openstreetmap.org/details.php?osmtype=W&osmid=38210407&format=json)
  96
  97
  98 ```json
  99 {
 100   "place_id": 85993608,
 101   "parent_place_id": 72765313,
 102   "osm_type": "W",
 103   "osm_id": 38210407,
 104   "category": "place",
 105   "type": "square",
 106   "admin_level": "15",
 107   "localname": "Pariser Platz",
 108   "names": {
 109     "name": "Pariser Platz",
 110     "name:be": "Парыжская плошча",
 111     "name:de": "Pariser Platz",
 112     "name:es": "Plaza de París",
 113     "name:he": "פאריזר פלאץ",
 114     "name:ko": "파리저 광장",
 115     "name:la": "Forum Parisinum",
 116     "name:ru": "Парижская площадь",
 117     "name:uk": "Паризька площа",
 118     "name:zh": "巴黎廣場"
 119   },
 120   "addresstags": {
 121     "postcode": "10117"
 122   },
 123   "housenumber": null,
 124   "calculated_postcode": "10117",
 125   "country_code": "de",
 126   "indexed_date": "2018-08-18T17:02:45+00:00",
 127   "importance": 0.339401620591472,
 128   "calculated_importance": 0.339401620591472,
 129   "extratags": {
 130     "wikidata": "Q156716",
 131     "wikipedia": "de:Pariser Platz"
 132   },
 133   "calculated_wikipedia": "de:Pariser_Platz",
 134   "rank_address": 30,
 135   "rank_search": 30,
 136   "isarea": true,
 137   "centroid": {
 138     "type": "Point",
 139     "coordinates": [
 140       13.3786822618517,
 141       52.5163654
 142     ]
 143   },
 144   "geometry": {
 145     "type": "Point",
 146     "coordinates": [
 147       13.3786822618517,
 148       52.5163654
 149     ]
 150   }
 151 }
 152 ```