X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/fae8da2bcb78d6020231b42a5a3f2444b64755eb..c611d49941e8a097116dfb6f6d08e5491a85dcee:/docs/api/Output.md?ds=sidebyside diff --git a/docs/api/Output.md b/docs/api/Output.md index 4aa4d298..2f9bdaeb 100644 --- a/docs/api/Output.md +++ b/docs/api/Output.md @@ -1,6 +1,6 @@ # Place Output -The [\reverse](Reverse.md), [\search](Search.md) and [\lookup](Lookup.md) +The [/reverse](Reverse.md), [/search](Search.md) and [/lookup](Lookup.md) API calls produce very similar output which is explained in this section. There is one section for each format which is selectable via the `format` parameter. @@ -46,9 +46,9 @@ a single place (for reverse) of the following format: The possible fields are: - * `place_id` - reference to the Nominatim internal database ID (see notes below) + * `place_id` - reference to the Nominatim internal database ID ([see notes](#place_id-is-not-a-persistent-id)) * `osm_type`, `osm_id` - reference to the OSM object - * `boundingbox` - area of corner coordinates + * `boundingbox` - area of corner coordinates ([see notes](#boundingbox)) * `lat`, `lon` - latitude and longitude of the centroid of the object * `display_name` - full comma-separated address * `class`, `type` - key and value of the main OSM tag @@ -70,12 +70,12 @@ This is the same as the JSON format with two changes: ### GeoJSON -This format follows the [RFC7946](http://geojson.org). Every feature includes +This format follows the [RFC7946](https://geojson.org). Every feature includes a bounding box (`bbox`). The feature list has the following fields: - * `place_id` - reference to the Nominatim internal database ID (see notes below) + * `place_id` - reference to the Nominatim internal database ID ([see notes](#place_id-is-not-a-persistent-id)) * `osm_type`, `osm_id` - reference to the OSM object * `category`, `type` - key and value of the main OSM tag * `display_name` - full comma-separated address @@ -83,7 +83,7 @@ The feature list has the following fields: * `importance` - computed importance rank * `icon` - link to class icon (if available) * `address` - dictionary of address details (only with `addressdetails=1`) - * `extratags` - dictionary with additional useful tags like website or maxspeed + * `extratags` - dictionary with additional useful tags like `website` or `maxspeed` (only with `extratags=1`) * `namedetails` - dictionary with full list of available names including ref etc. @@ -100,12 +100,9 @@ The following feature attributes are implemented: * `type` - value of the main tag of the object (e.g. residential, restaurant, ...) * `label` - full comma-separated address * `name` - localised name of the place - * `housenumber`, `street`, `locality`, `postcode`, `city`, - `district`, `county`, `state`, `country` - + * `housenumber`, `street`, `locality`, `district`, `postcode`, `city`, + `county`, `state`, `country` - provided when it can be determined from the address - (see [this issue](https://github.com/openstreetmap/Nominatim/issues/1080) for - current limitations on the correctness of the address) and `addressdetails=1` - was given * `admin` - list of localised names of administrative boundaries (only with `addressdetails=1`) Use `polygon_geojson` to output the full geometry of the object instead @@ -120,7 +117,7 @@ formats depending on the API call. ``` @@ -203,11 +200,11 @@ generic information about the query: The place information can be found in the `place` elements, of which there may be more than one. The attributes of that element contain: - * `place_id` - reference to the Nominatim internal database ID (see notes below) + * `place_id` - reference to the Nominatim internal database ID ([see notes](#place_id-is-not-a-persistent-id)) * `osm_type`, `osm_id` - reference to the OSM object * `ref` - content of `ref` tag if it exists * `lat`, `lon` - latitude and longitude of the centroid of the object - * `boundingbox` - comma-separated list of corner coordinates + * `boundingbox` - comma-separated list of corner coordinates ([see notes](#boundingbox)) * `place_rank` - class search rank * `display_name` - full comma-separated address * `class`, `type` - key and value of the main OSM tag @@ -232,7 +229,7 @@ permanent for later use. The combination `osm_type`+`osm_id` is slighly better but remember in OpenStreetMap mappers can delete, split, recreate places (and those -get a new `osm_id`), there is no link between those old and new id. +get a new `osm_id`), there is no link between those old and new ids. Places can also change their meaning without changing their `osm_id`, e.g. when a restaurant is retagged as supermarket. For a more in-depth discussion see [Permanent ID](https://wiki.openstreetmap.org/wiki/Permanent_ID). @@ -244,3 +241,10 @@ relation) so `osm_type`+`osm_id`+`class_name` would be more unique. Comma separated list of min latitude, max latitude, min longitude, max longitude. The whole planet would be `-90,90,-180,180`. + +Can we used to pan and center the map on the result, for example with leafletjs +mapping library +`map.fitBounds([[bbox[0],bbox[2]],[bbox[1],bbox[3]]], {padding: [20, 20], maxzoom: 16});` + +Bounds crossing the antimeridian have a min latitude -180 and max latitude 180, +essentially covering the planet (See [issue 184](https://github.com/openstreetmap/Nominatim/issues/184)).