/v4/geocoding/searchGeocoding (Search)
Match a query string to geographic coordinates.
Usage guidelines for autocomplete
Fast typers may send a lot of requests at once and their device/network may not perform well with many open connections. Because of this, some kind of client-side request throttling must be implemented.
Furthermore, requests are asynchronous and you must account for the fact that responses may not be received in the same order they were requested.
Request Headers
string
Required authentication header.
string
Required authentication header.
BCP47 | optional
Request geocoding results to be in specific language if it is available. If it is not - it will default to English. BCP47 specification
Request GET parameters
string
A query to geocode. Can be an address, a postcode or a venue.
For example SW1A 0AA or Victoria street, London. Providing a country or city the request will get you more accurate results.
array[ISO 3166-1 alpha-2 or alpha-3] | optional
Only return the results that are within the specified country.
integer | optional
Expected integer between 1 and 50. Limits amount of results returned to specified number.
boolean | optional
Forcefully adds postcode to search response. Only works if Switzerland as CH is specified as the value of the within.country parameter.
experimental | boolean | optional
Format the name field of the geocoding search response to a well formatted, human-readable address of the location.
boolean | optional
Exclude the country from the formatted name field (used only if format.name is equal true).
string | optional
Used to limit the results to a bounding box. Expected four comma-separated floats marking a south-east and north-west corners of a rectangle: min-latitude,min-longitude,max-latitude,max-longitude. Example of bounds parameter value for Scandinavia: 54.16243,4.04297,71.18316,31.81641
Response Headers
BCP47
Language tag in which results were returned.
It will default to Content-Language: en if requested language was not available. BCP47 spec.
Response Body
FeatureCollection
string
array[object]
object
experimental | string
Well formatted, human-readable address of the location.
string
Full comma-separated address of the location, composed of names of all enclosing regions/boundaries.
string
string
float | optional
Result confidence score, maximum value is 1.
string | optional
string | optional
string | optional
string | optional
string | optional
string | optional
string | optional
string | optional
string | optional
string | optional
string | optional
string | optional
ISO 3166-1 alpha-3 | optional
string | optional
string | optional
object | optional
object | optional
Public transport support information. Public transport is not supported if this object is missing.
date in extended ISO-8601 format
date in extended ISO-8601 format
object | optional
Fast time-filter support information. The time-filter/fast endpoint is not supported if this object is missing.
array[object]
Each entry in the array describes a time period and time filter modes that are available for this country.
The arrival or departure time period for which this time filter fast endpoint is available. Possible values: weekday_morning
array[object]
Lists available transportation and time-filter modes for this time period.
Possible values arrival.many_to_one, arrival.one_to_many.
Possible values public_transport, driving, driving+public_transport.
array[string]
Array of supported transportation modes while doing cross country search
boolean
Indicates whether or not we have fare data
boolean
Indicates whether or not postcode searches are supported
Examples
Request
Response Body
Example Request
LoadingResponse Body
Loading