]> git.openstreetmap.org Git - nominatim.git/blobdiff - docs/api/Details.md
Merge pull request #3587 from danieldegroot2/lookup-spelling
[nominatim.git] / docs / api / Details.md
index 5992f952a4c91b76548bb89ac23f426c99b28f36..b836efd30eaed27a77bee37e09014ebdf3dea219 100644 (file)
@@ -2,12 +2,11 @@
 
 Show all details about a single place saved in the database.
 
-This API endpoint is meant for visual inspection of the data in the database
-and is meant for use with [Nominatim-UI](https://github.com/osm-search/nominatim-ui/).
+This API endpoint is meant for visual inspection of the data in the database,
+mainly together with [Nominatim-UI](https://github.com/osm-search/nominatim-ui/).
 The parameters of the endpoint and the output may change occasionally between
 versions of Nominatim. Do not rely on the output in scripts or applications.
 
-
 !!! warning
     The details endpoint at https://nominatim.openstreetmap.org
     may not used in scripts or bots at all.
@@ -56,17 +55,10 @@ This section lists additional optional parameters.
 |-----------| ----- | ------- |
 | json_callback | function name | _unset_ |
 
-When given, then JSON output will be wrapped in a callback function with
+When set, then JSON output will be wrapped in a callback function with
 the given name. See [JSONP](https://en.wikipedia.org/wiki/JSONP) for more
 information.
 
-| Parameter | Value | Default |
-|-----------| ----- | ------- |
-| pretty    | 0 or 1 | 0 |
-
-`[PHP-only]` Add indentation to the output to make it more human-readable.
-
-
 ### Output details
 
 | Parameter | Value | Default |
@@ -96,10 +88,8 @@ members.
 |-----------| ----- | ------- |
 | hierarchy  | 0 or 1 | 0 |
 
-Include details of places lower in the address hierarchy.
-
-`[Python-only]` will only return properly parented places. These are address
-or POI-like places that reuse the address of their parent street or place.
+Include details of POIs and address that depend on the place. Only POIs
+that use this place to determine their address will be returned.
 
 | Parameter | Value | Default |
 |-----------| ----- | ------- |
@@ -130,7 +120,7 @@ as the ["Accept-Language" HTTP header](https://developer.mozilla.org/en-US/docs/
 
 ##### JSON
 
-[https://nominatim.openstreetmap.org/details.php?osmtype=W&osmid=38210407&format=json](https://nominatim.openstreetmap.org/details.php?osmtype=W&osmid=38210407&format=json)
+[https://nominatim.openstreetmap.org/details?osmtype=W&osmid=38210407&format=json](https://nominatim.openstreetmap.org/details?osmtype=W&osmid=38210407&format=json)
 
 
 ```json