Overview
Developer Tools
Migration Guides
Travel Time Matrix API
Isochrone API
H3 API
Geohash API
Distance Map API
Routes API
Geocoding API
Additional API Reference
Error Handling
ArcGIS plugin
Alteryx plugin
/v4/geocoding/search

Geocoding (Search)
Copy link

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
Copy link

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
Copy link

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 the south-west and north-east corners of: 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
Copy link

Language tag in which results were returned.
It will default to Content-Language: en if requested language was not available. BCP47 spec.

Response Body
Copy link

FeatureCollection
array[object]
Hide child attributes
Feature
Show child attributes
Hide child attributes
experimental | string

Well formatted, human-readable address of the location.

Full comma-separated address of the location, composed of names of all enclosing regions/boundaries.

float | optional

Result confidence score, maximum value is 1.

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
Show child attributes

Examples
Copy link

Request
Copy link

Loading

Response Body
Copy link

Loading
Hide code example

Request

Loading

Response

Loading