X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/6e5f595d48be5745dfd9b8d902ccb9a0a4a80601..5ec07321d4b6c8aa28751b95668e4b9cd1c9bb9c:/docs/api/Details.md?ds=sidebyside diff --git a/docs/api/Details.md b/docs/api/Details.md index 5992f952..b836efd3 100644 --- a/docs/api/Details.md +++ b/docs/api/Details.md @@ -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