Merge pull request #3054 from lonvia/add-amenity-to-documentation

[nominatim.git] / docs / api / Reverse.md

diff --git a/docs/api/Reverse.md b/docs/api/Reverse.md
index a1b46b0fc2c56505cdf9142021eee5bb3b34fd44..56281d06f2420c43990f95a44bd18bb4a1dd3725 100644 (file)
--- a/docs/api/Reverse.md
+++ b/docs/api/Reverse.md
@@ -27,15 +27,15 @@ The main format of the reverse API is
 https://nominatim.openstreetmap.org/reverse?lat=<value>&lon=<value>&<params>
 ```
 
 https://nominatim.openstreetmap.org/reverse?lat=<value>&lon=<value>&<params>
 ```
 

-where `lat` and `lon` are latitude and longitutde of a coordinate in WGS84
+where `lat` and `lon` are latitude and longitude of a coordinate in WGS84

 projection. The API returns exactly one result or an error when the coordinate
 is in an area with no OSM data coverage.
 
 projection. The API returns exactly one result or an error when the coordinate
 is in an area with no OSM data coverage.
 

-Additional paramters are accepted as listed below.
+Additional parameters are accepted as listed below.

 
 !!! warning "Deprecation warning"
     The reverse API used to allow address lookup for a single OSM object by
 
 !!! warning "Deprecation warning"
     The reverse API used to allow address lookup for a single OSM object by

-    its OSM id. This use is now deprecated. Use the [Address Lookup API](../Lookup)
+    its OSM id. This use is now deprecated. Use the [Address Lookup API](Lookup.md)

     instead.
 
 ### Output format
     instead.
 
 ### Output format


@@ -92,7 +92,10 @@ In terms of address details the zoom levels are as follows:
   5   | state
   8   | county
   10  | city
   5   | state
   8   | county
   10  | city

-  14  | suburb
+  12  | town / borough
+  13  | village / suburb
+  14  | neighbourhood
+  15  | locality

   16  | major streets
   17  | major and minor streets
   18  | building
   16  | major streets
   17  | major and minor streets
   18  | building


@@ -118,7 +121,7 @@ geometry. Topology is preserved in the result. (Default: 0.0)
 
 * `email=<valid email address>`
 
 
 * `email=<valid email address>`
 

-If you are making large numbers of request please include an appropriate email
+If you are making a large number of requests, please include an appropriate email

 address to identify your requests. See Nominatim's [Usage Policy](https://operations.osmfoundation.org/policies/nominatim/) for more details.
 
 
 address to identify your requests. See Nominatim's [Usage Policy](https://operations.osmfoundation.org/policies/nominatim/) for more details.
 
 


@@ -162,7 +165,7 @@ This overrides the specified machine readable format. (Default: 0)
   "licence":"Data © OpenStreetMap contributors, ODbL 1.0. https:\/\/www.openstreetmap.org\/copyright",
   "osm_type":"way",
   "osm_id":"280940520",
   "licence":"Data © OpenStreetMap contributors, ODbL 1.0. https:\/\/www.openstreetmap.org\/copyright",
   "osm_type":"way",
   "osm_id":"280940520",

-"lat":"-34.4391708",
+  "lat":"-34.4391708",

   "lon":"-58.7064573",
   "place_rank":"26",
   "category":"highway",
   "lon":"-58.7064573",
   "place_rank":"26",
   "category":"highway",