TravelTime Docs logo
TravelTime API
Overview
Developer Tools
Database Plugins
TravelTime API
SDK
TravelTime API
Isochrone API
JSON
Travel Time Matrix API
JSON
Travel Time Matrix API
Protocol Buffers
Routes API
Geocoding API
Additional API Reference
Error Handling
TravelTime API
ArcGIS plugin
QGIS plugin
Alteryx plugin
/v4/geocoding/search

Geocoding (Search)anchor icon

Match a query string to geographic coordinates.

Usage guidelines for autocompleteanchor icon

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 Headersanchor icon

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 parametersanchor icon

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.

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 Headersanchor icon

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

Response Bodyanchor icon

FeatureCollection

array[object]

Hide child attributes

Feature

Show child attributes

array[number, number]

The coordinates of the locations. [lng, lat]

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

Public transport support information. Public transport is not supported if this object is missing.

Show child attributes

date in extended ISO-8601 format

date in extended ISO-8601 format

Fast time-filter support information. The time-filter/fast endpoint is not supported if this object is missing.

Show child attributes

Each entry in the array describes a time period and time filter modes that are available for this country.

Show child attributes

The arrival or departure time period for which this time filter fast endpoint is available. Possible values: weekday_morning

Lists available transportation and time-filter modes for this time period.

Show child attributes

Possible values arrival.many_to_one, arrival.one_to_many.

Possible values public_transport, driving, driving+public_transport.

Array of supported transportation modes while doing cross country search

Indicates whether or not we have fare data

Indicates whether or not postcode searches are supported

Examplesanchor icon

Requestanchor icon

Loading

Response Bodyanchor icon

Loading

Example Request

Loading

Response Body

Loading