X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/eaee87e73decb643939ddf3ce64cd6d6373d71e2..baee6f3de09226c3dc41cb2314a0ac348e865561:/docs/api/Output.md?ds=inline
diff --git a/docs/api/Output.md b/docs/api/Output.md
index a37cbe0b..d59f75dd 100644
--- a/docs/api/Output.md
+++ b/docs/api/Output.md
@@ -28,6 +28,7 @@ a single place (for reverse) of the following format:
"city": "London",
"state_district": "Greater London",
"state": "England",
+ "ISO3166-2-lvl4": "GB-ENG",
"postcode": "SW1A 2DU",
"country": "United Kingdom",
"country_code": "gb"
@@ -97,7 +98,10 @@ The GeocodeJSON format follows the
The following feature attributes are implemented:
* `osm_type`, `osm_id` - reference to the OSM object (unofficial extension, [see notes](#osm-reference))
- * `type` - value of the main tag of the object (e.g. residential, restaurant, ...)
+ * `type` - the 'address level' of the object ('house', 'street', `district`, `city`,
+ `county`, `state`, `country`, `locality`)
+ * `osm_key`- key of the main tag of the OSM object (e.g. boundary, highway, amenity)
+ * `osm_value` - value of the main tag of the OSM object (e.g. residential, restaurant)
* `label` - full comma-separated address
* `name` - localised name of the place
* `housenumber`, `street`, `locality`, `district`, `postcode`, `city`,
@@ -126,6 +130,7 @@ formats depending on the API call.
Bavaria
+ DE-BY
Germany
de
@@ -179,6 +184,7 @@ Additional information requested with `addressdetails=1`, `extratags=1` and
London
Greater London
England
+ GB-ENG
SW1A 2DU
United Kingdom
gb
@@ -279,7 +285,7 @@ with a designation label. Per default the following labels may appear:
* continent
* country, country_code
- * region, state, state_district, county
+ * region, state, state_district, county, ISO3166-2-lvl
* municipality, city, town, village
* city_district, district, borough, suburb, subdivision
* hamlet, croft, isolated_dwelling
@@ -290,6 +296,7 @@ with a designation label. Per default the following labels may appear:
* emergency, historic, military, natural, landuse, place, railway,
man_made, aerialway, boundary, amenity, aeroway, club, craft, leisure,
office, mountain_pass, shop, tourism, bridge, tunnel, waterway
+ * postcode
They roughly correspond to the classification of the OpenStreetMap data
according to either the `place` tag or the main key of the object.