X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/90d531c640876a10e5be33ada826d62d46067b50..edb1eec46d0fd222f9b30e0e3d62e906c1c9059e:/docs/api/Lookup.md diff --git a/docs/api/Lookup.md b/docs/api/Lookup.md index 3b6472ad..a2ba714e 100644 --- a/docs/api/Lookup.md +++ b/docs/api/Lookup.md @@ -1,51 +1,154 @@ -## Address lookup +# Address lookup -Lookup the address of one or multiple OSM objects like node, way or relation. +The lookup API allows to query the address and other details of one or +multiple OSM objects like node, way or relation. + +## Endpoint + +The lookup API has the following format: -### Parameters ``` - https://nominatim.openstreetmap.org/lookup? + https://nominatim.openstreetmap.org/lookup?osm_ids=[N|W|R],…,…,& ``` -* `format=[xml|json]` +`osm_ids` is mandatory and must contain a comma-separated list of OSM ids each +prefixed with its type, one of node(N), way(W) or relation(R). Up to 50 ids +can be queried at the same time. + +!!! danger "Deprecation warning" + The API can also be used with the URL + `https://nominatim.openstreetmap.org/lookup.php`. This is now deprecated + and will be removed in future versions. + + +## Parameters + +This section lists additional optional parameters. + +### Output format + +| Parameter | Value | Default | +|-----------| ----- | ------- | +| format | one of: `xml`, `json`, `jsonv2`, `geojson`, `geocodejson` | `jsonv2` | + +See [Place Output Formats](Output.md) for details on each format. + + +| Parameter | Value | Default | +|-----------| ----- | ------- | +| json_callback | function name | _unset_ | + +When given, 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. + +Only has an effect for JSON output formats. + + +### Output details + +| Parameter | Value | Default | +|-----------| ----- | ------- | +| addressdetails | 0 or 1 | 0 | + +When set to 1, include a breakdown of the address into elements. +The exact content of the address breakdown depends on the output format. + +!!! tip + If you are interested in a stable classification of address categories + (suburb, city, state, etc), have a look at the `geocodejson` format. + All other formats return classifications according to OSM tagging. + There is a much larger set of categories and they are not always consistent, + which makes them very hard to work with. + - * Output format +| Parameter | Value | Default | +|-----------| ----- | ------- | +| extratags | 0 or 1 | 0 | -* `json_callback=` +When set to 1, the response include any additional information in the result +that is available in the database, e.g. wikipedia link, opening hours. - * Wrap json output in a callback function (JSONP) i.e. `()` -* `accept-language=` +| Parameter | Value | Default | +|-----------| ----- | ------- | +| namedetails | 0 or 1 | 0 | - * Preferred language order for showing search results, overrides the value specified in the "Accept-Language" HTTP header. - * Either uses standard rfc2616 accept-language string or a simple comma separated list of language codes. +When set to 1, include a full list of names for the result. These may include +language variants, older names, references and brand. -* `osm_ids=[N|W|R],…,[N|W|R]` +| Parameter | Value | Default | +|-----------| ----- | ------- | +| accept-language | browser language string | content of "Accept-Language" HTTP header | - * If you are making large numbers of request please include a valid email address or alternatively include your email address as part of the User-Agent string. - * This information will be kept confidential and only used to contact you in the event of a problem, see [Usage Policy](https://operations.osmfoundation.org/policies/nominatim/) for more details. +Preferred language order for showing search results. This may either be +a simple comma-separated list of language codes or have the same format +as the ["Accept-Language" HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language). -* `extratags=1` - * Include additional information in the result if available, e.g. wikipedia link, opening hours. +!!! tip + First-time users of Nominatim tend to be confused that they get different + results when using Nominatim in the browser versus in a command-line tool + like wget or curl. The command-line tools + usually don't send any Accept-Language header, prompting Nominatim + to show results in the local language. Browsers on the contratry always + send the currently chosen browser language. -* `namedetails=1` - * Include a list of alternative names in the results. - * These may include language variants, references, operator and brand. -### Example +### Polygon output -* [https://nominatim.openstreetmap.org/lookup?osm_ids=R146656,W104393803,N240109189](https://nominatim.openstreetmap.org/lookup?osm_ids=R146656,W104393803,N240109189) +| Parameter | Value | Default | +|-----------| ----- | ------- | +| polygon_geojson | 0 or 1 | 0 | +| polygon_kml | 0 or 1 | 0 | +| polygon_svg | 0 or 1 | 0 | +| polygon_text | 0 or 1 | 0 | + +Add the full geometry of the place to the result output. Output formats +in GeoJSON, KML, SVG or WKT are supported. Only one of these +options can be used at a time. + +| Parameter | Value | Default | +|-----------| ----- | ------- | +| polygon_threshold | floating-point number | 0.0 | + +When one of the polygon_* outputs is chosen, return a simplified version +of the output geometry. The parameter describes the +tolerance in degrees with which the geometry may differ from the original +geometry. Topology is preserved in the geometry. + + +### Other + +| Parameter | Value | Default | +|-----------| ----- | ------- | +| email | valid email address | _unset_ | + +If you are making large numbers of request please include an appropriate email +address to identify your requests. See Nominatim's +[Usage Policy](https://operations.osmfoundation.org/policies/nominatim/) for more details. + + +| Parameter | Value | Default | +|-----------| ----- | ------- | +| debug | 0 or 1 | 0 | + +Output assorted developer debug information. Data on internals of Nominatim's +"search loop" logic, and SQL queries. The output is HTML format. +This overrides the specified machine readable format. + + +## Examples + +##### XML + +[https://nominatim.openstreetmap.org/lookup?osm_ids=R146656,W104393803,N240109189](https://nominatim.openstreetmap.org/lookup?osm_ids=R146656,W50637691,N240109189) ```xml - - + + Manchester Greater Manchester North West England @@ -53,23 +156,72 @@ Lookup the address of one or multiple OSM objects like node, way or relation. United Kingdom gb - - Brandenburg Gate - 1 - Pariser Platz - Mitte - Mitte - Berlin - Berlin - 10117 + + Brandenburger Tor + Brandenburger Straße + Historische Innenstadt + Potsdam + Brandenburg + 14467 Germany de - + Berlin Berlin + 10178 Germany de ``` + +##### JSON with extratags + +[https://nominatim.openstreetmap.org/lookup?osm_ids=W50637691&format=json&extratags=1](https://nominatim.openstreetmap.org/lookup?osm_ids=W50637691&format=json&extratags=1) + +```json +[ + { + "place_id": 115462561, + "licence": "Data © OpenStreetMap contributors, ODbL 1.0. https://osm.org/copyright", + "osm_type": "way", + "osm_id": 50637691, + "boundingbox": [ + "52.3994612", + "52.3996426", + "13.0479574", + "13.0481754" + ], + "lat": "52.399550700000006", + "lon": "13.048066846939687", + "display_name": "Brandenburger Tor, Brandenburger Straße, Historische Innenstadt, Innenstadt, Potsdam, Brandenburg, 14467, Germany", + "class": "tourism", + "type": "attraction", + "importance": 0.2940287400552381, + "address": { + "tourism": "Brandenburger Tor", + "road": "Brandenburger Straße", + "suburb": "Historische Innenstadt", + "city": "Potsdam", + "state": "Brandenburg", + "postcode": "14467", + "country": "Germany", + "country_code": "de" + }, + "extratags": { + "image": "http://commons.wikimedia.org/wiki/File:Potsdam_brandenburger_tor.jpg", + "heritage": "4", + "wikidata": "Q695045", + "architect": "Carl von Gontard;Georg Christian Unger", + "wikipedia": "de:Brandenburger Tor (Potsdam)", + "wheelchair": "yes", + "description": "Kleines Brandenburger Tor in Potsdam", + "heritage:website": "http://www.bldam-brandenburg.de/images/stories/PDF/DML%202012/04-p-internet-13.pdf", + "heritage:operator": "bldam", + "architect:wikidata": "Q68768;Q95223", + "year_of_construction": "1771" + } + } +] +```