From d2b9493d72a2cdc04863408cc6cd4799561887fa Mon Sep 17 00:00:00 2001 From: Sarah Hoffmann Date: Sun, 5 Aug 2018 23:38:19 +0200 Subject: [PATCH] clean up and format search documentation --- docs/api/Overview.md | 14 +++ docs/api/Search.md | 202 ++++++++++++++++++++++++++----------------- docs/index.md | 7 ++ docs/mkdocs.yml | 1 + 4 files changed, 147 insertions(+), 77 deletions(-) create mode 100644 docs/api/Overview.md diff --git a/docs/api/Overview.md b/docs/api/Overview.md new file mode 100644 index 00000000..8bf14c43 --- /dev/null +++ b/docs/api/Overview.md @@ -0,0 +1,14 @@ +### Nominatim API + +Nominatim indexes named (or numbered) features with the OSM data set and a subset of other unnamed features (pubs, hotels, churches, etc). + +Its API has the following endpoints for querying the data: + + * __[/search](Search.md)__ - search OSM objects by name or type + * __[/reverse](Reverse.md)__ - search OSM object by their location + * __[/lookup](Lookup.md)__ - look up address details for OSM objects by thier ID + * __/status__ - query the status of the server + * __/deletable__ - list objects that have been deleted in OSM but are held + back in Nominatim in case the deletion was accidental + * __/polygons__ - list of broken polygons detected by Nominatim + * __/details__ - show internal details for an object (for debugging only) diff --git a/docs/api/Search.md b/docs/api/Search.md index e2c55fa5..1cb6cef0 100644 --- a/docs/api/Search.md +++ b/docs/api/Search.md @@ -1,125 +1,173 @@ +# Search queries -## Search -Nominatim indexes named (or numbered) features with the OSM data set and a subset of other unnamed features (pubs, hotels, churches, etc) +The search API allows to look up a location from a textual description. +Nominatim supports structured as well as free-form search queries. -Search terms are processed first left to right and then right to left if that fails. +The search query may also contain +[special phrases](https://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases) +which are tranlated into specific OpenStreetMap(OSM) tags (e.g. Pub => amenity=pub). +Note that this only limits the items to be found. It is not suited to return complete +lists of OSM objects of a specific type. +Use [Overpass API](https://overpass-api.de/) for that. -Both searches will work: [pilkington avenue, birmingham](//nominatim.openstreetmap.org/search?q=pilkington+avenue,birmingham), [birmingham, pilkington avenue](//nominatim.openstreetmap.org/search?q=birmingham,+pilkington+avenue) +## Parameters -(Commas are optional, but improve performance by reducing the complexity of the search.) +The search API has the following two formats: -Where house numbers have been defined for an area they should be used: [135 pilkington avenue, birmingham](//nominatim.openstreetmap.org/search?q=135+pilkington+avenue,+birmingham) - -### Special Keywords -Various keywords are translated into searches for specific osm tags (e.g. Pub => amenity=pub). A current list of [special phrases](https://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases) processed is available. +``` + https://nominatim.openstreetmap.org/search/? +``` -### Parameters +This format only accepts a free-form query string where the +parts of the query are separated by slashes. ``` https://nominatim.openstreetmap.org/search? - https://nominatim.openstreetmap.org/search/? ``` -* `format=[html|xml|json|jsonv2|geojson|geocodejson]` +In this form, the query may be given through two different sets of parameters: + +* `q=` - * Output format - * defaults to `html` + Free-form query string to search for. + Free-form queries are processed first left to right and then right to + left if that fails. So you may search for + [pilkington avenue, birmingham](//nominatim.openstreetmap.org/search?q=pilkington+avenue,birmingham) as well as for + [birmingham, pilkington avenue](//nominatim.openstreetmap.org/search?q=birmingham,+pilkington+avenue). + Commas are optional, but improve performance by reducing the complexity + of the search. + + +* `street= ` + `city=` + `county=` + `state=` + `country=` + `postalcode=` + + Alternative query string format for structured requests. + Structured requests are faster but are less robust against alternative + OSM tagging schemas. **Do not combine with** `q=` **parameter**. + +All three query forms accept the additional paramters listed below. + +### Output format + +* `format=[html|xml|json|jsonv2|geojson|geocodejson]` +See below for details on each format. (Default: html) * `json_callback=` - * Wrap json output in a callback function (JSONP) i.e. `()` +Wrap json output in a callback function (JSONP) i.e. `()`. +Only has an effect for JSON output formats. -* `accept-language=` +### Output details - * 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. +* `addressdetails=[0|1]` -* `q=` +Include a breakdown of the address into elements. (Default: 0) - * Query string to search for. - * Alternatively can be entered as: - * `street= ` - * `city=` - * `county=` - * `state=` - * `country=` - * `postalcode=` - - **(experimental)** Alternative query string format for structured requests. -Structured requests are faster and require fewer server resources. **Do not combine with `q=` parameter**. +* `extratags=[0|1]` -* `countrycodes=[,][,]...` +Include additional information in the result if available, +e.g. wikipedia link, opening hours. (Default: 0) - * Limit search results to a specific country (or a list of countries). - * `` should be the ISO 3166-1alpha2 code, e.g. `gb` for the United Kingdom, `de` for Germany, etc. -* `viewbox=,,,` - * The preferred area to find search results. Any two corner points of the box are accepted in any order as long as they span a real box. +* `namedetails=[0|1]` -* `bounded=[0|1]` - * defaults to 0 - * Restrict the results to only items contained with the viewbox (see above). - * Restricting the results to the bounding box also enables searching by amenity only. - * For example a search query of just `"[pub]"` would normally be rejected but with `bounded=1` will result in a list of items matching within the bounding box. +Include a list of alternative names in the results. These may include +language variants, references, operator and brand. (Default: 0) -* `polygon=[0|1]` - * defaults to 0 - * Output polygon outlines for items found **(deprecated, use one of the polygon_* parameters instead)** -* `addressdetails=[0|1]` - * defaults to 0 - * Include a breakdown of the address into elements +### Language of results -* `email=` +* `accept-language=` + +Preferred language order for showing search results, overrides the value +specified in the "Accept-Language" HTTP header. +Either use a standard RFC2616 accept-language string or a simple +comma-separated list of language codes. + +### Result limitation + +* `countrycodes=[,][,]...` + +Limit search results to one or more countries. `` must be the +ISO 3166-1alpha2 code, e.g. `gb` for the United Kingdom, `de` for Germany. - * 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. * `exclude_place_ids=` - * defaults to 10 - * Limit the number of returned results. -* `dedupe=[0|1]` - * defaults to 1 - * Sometimes you have several objects in OSM identifying the same place or object in reality. The simplest case is a street being split in many different OSM ways due to different characteristics. - * Nominatim will attempt to detect such duplicates and only return one match; this is controlled by the dedupe parameter which defaults to 1. Since the limit is, for reasons of efficiency, enforced before and not after de-duplicating, it is possible that de-duplicating leaves you with less results than requested. +Limit the number of returned results. (Default: 10) -* `debug=[0|1]` - * defaults to 0 - * Output assorted developer debug information. Data on internals of nominatim "Search Loop" logic, and SQL queries. The output is (rough) HTML format. This overrides the specified machine readable format. -* `polygon_geojson=1` - * Output geometry of results in geojson format. +* `viewbox=,,,` -* `polygon_kml=1` - * Output geometry of results in kml format. +The preferred area to find search results. Any two corner points of the box +are accepted in any order as long as they span a real box. -* `polygon_svg=1` - * Output geometry of results in svg format. +* `bounded=[0|1]` + +When a viewbox is given, restrict the result to items contained with that +viewbox (see above). When `viewbox` and `bounded` are given, an amenity +only search is allowed. In this case, give the special keyword for the +amenity in squaer brackets, e.g. `[pub]`. (Default: 0) + + +### Polygon output + +* `polygon_geojson=1` +* `polygon_kml=1` +* `polygon_svg=1` * `polygon_text=1` - * Output geometry of results as a WKT. + +Output geometry of results as a GeoJSON, KML, SVG or WKT. Only one of these +options can be used at a time. (Default: 0) * `polygon_threshold=0.0` - * defaults to 0.0 - * Simplify the output geometry before returning. The parameter is the - tolerance in degrees with which the geometry may differ from the original - geometry. Topology is preserved in the result. -* `extratags=1` - * Include additional information in the result if available, e.g. wikipedia link, opening hours. +Simplify the output geometry before returning. The parameter is the +tolerance in degrees with which the geometry may differ from the original +geometry. Topology is preserved in the result. (Default: 0.0) + +### Other + +* `email=` + +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. + +* `dedupe=[0|1]` + +Sometimes you have several objects in OSM identifying the same place or +object in reality. The simplest case is a street being split in many +different OSM ways due to different characteristics. Nominatim will +attempt to detect such duplicates and only return one match unless +this parameter is set to 0. (Default: 1) -* `namedetails=1` - * Include a list of alternative names in the results. - * These may include language variants, references, operator and brand. -### Examples + +* `debug=[0|1]` + +Output assorted developer debug information. Data on internals of Nominatim's +"Search Loop" logic, and SQL queries. The output is (rough) HTML format. +This overrides the specified machine readable format. (Default: 0) + + + +## Examples ##### XML with polygon points @@ -301,4 +349,4 @@ Structured requests are faster and require fewer server resources. **Do not comb } ] } -``` \ No newline at end of file +``` diff --git a/docs/index.md b/docs/index.md index 41eadde1..d348fcfa 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1 +1,8 @@ Nominatim (from the Latin, 'by name') is a tool to search OSM data by name and address and to generate synthetic addresses of OSM points (reverse geocoding). + +This guide comes in three parts: + + * __[API reference](api/Overview.md)__ for users of Nominatim + * __[Administration Guide](admin/Installation.md)__ for those who want + to install their own Nominatim server + * __[Developer's Guide](develop/overview.md)__ for developers of the software diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index b2ff881c..b11d5d98 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -6,6 +6,7 @@ repo_url: https://github.com/openstreetmap/Nominatim pages: - 'Introduction' : 'index.md' - 'API Reference': + - 'Overview': 'api/Overview.md' - 'Search': 'api/Search.md' - 'Reverse': 'api/Reverse.md' - 'Address Lookup': 'api/Lookup.md' -- 2.39.5