CrossStreet lookup

This endpoint returns address information and coordinates for a position to the nearest intersection.

There may be times when you need to translate a coordinate (for example: 37.786505,-122.3862) into a human-understandable street address.
Most often this is needed in tracking applications where you receive a GPS feed from the device or an asset, and wish to know the position and address information of the nearest intersection/crossroad to its initial position.

You can easily run this and other endpoints.

Go to the TomTom API Explorer page.
Click an endpoint.
1. Click Try it out.
2. Enter/select all required parameter values and any optional parameter values.
3. At the bottom of the form, click Execute.
4. Review the Response.

HTTPS Method: GET

URL format

GET https://<baseURL>/search/<versionNumber>/reverseGeocode/crossStreet/<position>.<ext>?key=<Your_API_Key>[&limit=<limit>][&heading=<heading>][&radius=<radius>][&language=<language>][&allowFreeformNewline=<allowFreeformNewline>][&view=<view>]

Request parameters

The following table describes the parameters that can be used in a Request.

Required parameters must be used or the call will fail.
Optional parameters, which are highlighted with [square brackets], may be used.
If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.
The order of request parameters is not important.

Required parameters
Parameter	Description
`baseURL` string	The base URL for calling the API. Value: `api.tomtom.com`
`versionNumber` string	The service version number. Value: The current version number value is `2`.
`position` string	This is specified as a comma separated string composed by lat,lon (e.g., `37.337,-121.89`). Value: A comma separated string composed by `lat`,`lon`. Example: `37.553,-122.453`
`ext` string	A valid response format: Values: JSON, JSONP, JS, or XML
`key` string	An API Key valid for the requested service. Value: Your valid `API Key`.
Optional parameters
Parameter	Description
`[limit]` integer	The maximum number of responses that will be returned. Default value: `1` (when the [limit] parameter is absent) Maximum value: `100`
`[heading]` float	The directional heading of the vehicle in degrees, for travel along a segment of roadway. `0` is North, `90` is East, etc. The precision can include up to one decimal place. Value: Values range from `-360` to `360`.
`[radius]` integer	The maximum distance in meters from the specified position for the `reverseGeocode` to consider. Default value: `10000` meters (10 km).
`[language]` string	The language in which the search results should be returned. Should be one of the supported IETF language tags, case insensitive. When data in a specified language is not available for a specific field, the default language is used. Default value: NGT Deprecation notice: Support for no-NO will be removed in favour of no-NB.
`[allowFreeformNewline]` boolean	The format of newlines in the formatted address. If `true`, the address will contain newlines. Otherwise, newlines will be converted to spaces. Default value: `false`.
`[view]` string	Geopolitical View. The context used to resolve the handling of disputed territories. Views include Unified, along with AR, IL, IN, MA, PK, RU, TR, and CN which are respectively tailored for Argentina, Israel, India, Morocco, Pakistan, Russia, Turkey, and China. Default values: Argentina, default view: AR, available views: Unified, IL, IN, MA, PK, RU, TR, CN India, default view: IN, available views: - Morocco, default view: MA, available views: Unified, AR, IL, IN, PK, RU, TR, CN Pakistan, default view: PK, available views: Unified, AR, IL, IN, MA, RU, TR, CN Russia, default view: RU, available views: Unified, AR, IL, IN, MA, PK, TR, CN Turkey, default view: TR, available views: Unified, AR, IL, IN, MA, PK, RU, CN China, default view: CN, available views: Unified, AR, IL, IN, MA, PK, RU, TR Others, default view: Unified, available views: AR, IL, IN, MA, PK, RU, TR, CN See the following section: Default view mapping.

Response body

For illustrative purposes the example below is neatly indented and includes all possible Response fields.

Actual Responses are more compact and the fields present will vary based on the result type and the data available.
See the following Response field section for more information.

When requesting JSON output the Response has the following structure:

{
  "summary": {
    "numResults": 1,
    "queryTime": 176
  },
  "addresses": []
}

Each element of the addresses array is in the following format:

{
  "address": {
    "streetName": "Soquel Dr & Winkle Ave",
    "crossStreet": "Soquel Dr",
    "municipalitySubdivision": "Santa Cruz, Live Oak",
    "municipality": "Santa Cruz, Live Oak",
    "countrySecondarySubdivision": "Santa Cruz",
    "countryTertiarySubdivision": "Santa Cruz",
    "countrySubdivision": "CA",
    "postalCode": "95065",
    "countryCode": "US",
    "country": "United States Of America",
    "countryCodeISO3": "USA",
    "freeformAddress": "Soquel Dr & Winkle Ave, Santa Cruz, CA 95065",
    "countrySubdivisionName": "California",
    "street": "Winkle Ave"
  },
  "position": "36.9882,-121.97511"
}

▲ Return to top

Response fields

The following table describes all of the fields that can appear in a Response. Fields are listed by the Response section they belong to, and in the order that they appear in the Response.

▲ Return to top

Default view mapping

Default view is recognised based on the country the Request came from.

Primary fields
Field	Description
`summary{}` object	Summary information about the search that was performed. `summary{} object`
`addresses[]` array	Result list, sorted in descending order by score. `addresses[] array`
`summary{} object`
Field	Description
`numResults` integer	The number of Results in the response.
`queryTime` integer	Time spent on resolving the query.
`addresses[] array`
Field	Description
`address{}` object	The structured address for the Result. `address{} object`
`position` double (LatLon)	Position of the result in a form of "latitude,longitude" coordinates. Example: `37.553,-122.453`
`address{} object`
Field	Description
`streetName` string	The street name.
`crossStreet` string	The street being crossed.
`municipalitySubdivision` string	Sub / Super City
`municipality` string	City / Town
`countrySecondarySubdivision` string	County
`countryTertiarySubdivision` string	Named Area.
`countrySubdivision` string	State or Province
`postalCode` string	Postal Code / Zip Code
`countryCode` string	Country (Note: This is a two-letter code, not a country name.)
`country` string	Country name
`countryCodeISO3` string	ISO alpha-3 country code
`freeformAddress` string	An address line formatted according to the formatting rules of a Result's country of origin, or in case of countries, its full country name.
`countrySubdivisionName` string	A full name of the first level of a country administrative hierarchy. This field appears only in case `countrySubdivision` is presented in an abbreviated form. Supported only for USA, Canada, and Great Britain.
`street` string	The street name.

Country	Default view	Other available views
Argentina	`AR`	`Unified, IL, IN, MA, PK, RU, TR`
India	`IN`	`-`
Morocco	`MA`	`Unified, AR, IL, IN, PK, RU, TR`
Pakistan	`PK`	`Unified, AR, IL, IN, MA, RU, TR`
Russia	`RU`	`Unified, AR, IL, IN, MA, PK, TR`
Turkey	`TR`	`Unified, AR, IL, IN, MA, PK, RU`
Others	`Unified`	`AR, IL, IN, MA, PK, RU, TR`

HTTP Response codes

The following table contains Response codes signifying successful and failed requests to an API server.

Code	Meaning & possible causes
`200`	OK: The search successfully returned zero or more results.
`400`	Bad Request: One or more parameters were incorrectly specified.
`403`	Forbidden: Possible causes include: Service requires SSL Not authorized Over QPS (Queries per second), or over QPD (Queries per day) Unknown referer
`405`	Method Not Allowed: The HTTP method (GET, POST, etc) is not supported for this Request.
`404/596`	Not Found: The HTTP Request method (GET, POST, etc) or path is incorrect.
`429`	Too Many Requests: The API key is over QPS (Queries per second).
`5xx`	Server Error: The service was unable to process your Request. Contact support to resolve the issue.

▲ Return to top

Response headers

The following table contains Response headers sent back from an API server.

Header	Description
`Access-Control-Allow-Origin`	Ensures that clients implementing the CORS security model are able to access the response from this service. Value: An asterisk "*" that signifies access to the TomTom API using the Access-Control-Allow-Origin (ACAO) header in its Response indicating which origin sites are allowed.
`Content-Type`	Indicates the format of the response, as chosen by the client. Format: `type/subtype; charset=utf-8` Value: type/subtype is one of: `application/json` `text/javascript` `text/xml`

▲ Return to Top

CrossStreet lookup

On this page

Purpose

Run this endpoint

Request data

HTTPS Method: GET

URL format

Request parameters

Response data

Response body

Response fields

Default view mapping

HTTP Response codes

Response headers