* **zoom**: zoom level from which you wish to view the world
* **bbox**: the bounding box frome which you want all your results to come
* **size**: (defaults to 10)
* **layers**: (defaults to `admin`)
* **details**: (defaults to `true`)
## /suggest
## /suggest
The autocomplete endpoint, it offers fast response time. Mixes results from around the provided lat/lon and also from precision level 1 and 3.
The autocompletion endpoint that offers very fast response times; ideal for completing partial user input. Mixes
results from around the provided lat/lon coordinates and also from precision level 1 and 3.
#### Required Parameters
#### Required Parameters
* **input**: query string
* **input**: query string
* **lat**: latitude
* **lat**, **lon**: The latitude/longitude coordinates to bias results towards.
* **lon**: longitude
* lat/lon are currently **required** because of this [open issue](https://github.com/elasticsearch/elasticsearch/issues/6444)
* lat/lon are **required** currently because of this [open issue](https://github.com/elasticsearch/elasticsearch/issues/6444)
#### Optional Parameters
#### Optional Parameters
* **zoom**: zoom level from which you wish to view the world
* **zoom**: zoom level from which you wish to view the world
@ -60,48 +54,35 @@ The autocomplete endpoint, it offers fast response time. Mixes results from arou
* **layers**: datasets you wish to query (defaults to `poi,admin,address`)
* **layers**: datasets you wish to query (defaults to `poi,admin,address`)
* **details**: (defaults to `true`)
* **details**: (defaults to `true`)
## /suggest/coarse
## /suggest/coarse
Only queries the admin layers.
Only queries the admin layers.
#### Required Parameters
#### Required Parameters
* **input**: query string
Same as `/suggest`.
* **lat**: latitude from where you are searching
* **lon**: longitude
* lat/lon are **required** currently because of this [open issue](https://github.com/elasticsearch/elasticsearch/issues/6444)
#### Optional Parameters
#### Optional Parameters
* **zoom**: zoom level from which you wish to view the world
Same as `/suggest`.
* **size**: number of results requested (defaults to 10)
* **layers**: datasets you wish to query (defaults to `admin`)
* **details**: (defaults to `true`)
## /suggest/nearby
## /suggest/nearby
Works as autocomplete for places located near a latitude/longitude, this endpoint is the same as `/suggest` but the results are all from within 50 kilometers of the specified point. Unlike `/suggest`, `/suggest/nearby` does not mix results from different precision levels (500km, 1000km etc from lat/lon).
Works as autocomplete for only the places located near a latitude/longitude; this endpoint is the same as `/suggest`
but the results are all from within 50 kilometers of the specified point. Unlike `/suggest`, `/suggest/nearby` does
not mix results from different precision levels (500km, 1000km etc from lat/lon).
#### Required Parameters
#### Required Parameters
* **input**: query string
Same as `/suggest`.
* **lat**: latitude
* **lon**: longitude
* lat/lon are **required** currently because of this [open issue](https://github.com/elasticsearch/elasticsearch/issues/6444)
#### Optional Parameters
#### Optional Parameters
* **zoom**: zoom level from which you wish to view the world
Same as `/suggest`.
* **size**: number of results you need (defaults to 10)
* **layers**: datasets you wish to query (defaults to `poi,admin,address`)
* **details**: (defaults to `true`)
## /reverse
## /reverse
Reverse geocoding endpoint.
The reverse geocoding endpoint; matches a point on the planet to the name of that place.
#### Required Parameters
#### Required Parameters
* **lat**: latitude
* **lat**, **lon**: The coordinates of the point.
* **lon**: longitude
#### Optional Parameters
#### Optional Parameters
* **zoom**: zoom level from which you wish to view the world
* **zoom**: zoom level from which you wish to view the world
@ -112,7 +93,7 @@ Reverse geocoding endpoint.
## /doc
## /doc
Retrieves a document or multiple documents at once.
The endpoint for retrieving one or more elasticsearch documents with specific ids.