CrossStreet Lookup
Purpose
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.
Run this endpoint
You can easily run this and other endpoints. Go to the TomTom API Explorer page and follow the directions.
Request data
HTTPS Method: GET
For ease of viewing and identification:
- Constants and parameters enclosed in curly brackets { } must be replaced with their values.
- Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.
URL request format
https://{baseURL}/search/{versionNumber}/reverseGeocode/crossStreet/{position}.{ext}?key={Your_API_Key}&limit={limit}&radius={radius}&language={language}&allowFreeformNewline={allowFreeformNewline}&view={view}
URL request example
https://api.tomtom.com/search/2/reverseGeocode/crossStreet/37.786505,-122.3862.json?key={Your_API_Key}
curl command request example
curl 'https://api.tomtom.com/search/2/reverseGeocode/crossStreet/37.786505,-122.3862.json?key={Your_API_Key}'
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 may be used.
- The order of request parameters is not important.
Required parameters | Description |
|---|---|
string | Base URL for calling the API. Values:
|
string | The service version number. Value: The current version number value is |
string | This is specified as a comma separated string composed by lat,lon (e.g.,
Value: A comma separated string composed by |
string | A valid response format: Values: |
string | An API Key valid for the requested service. Value: Your valid |
Optional parameters | Description |
|---|---|
integer | The maximum number of responses that will be returned. Default value: Maximum value: |
integer | The maximum distance in meters from the specified position for the
Default value: |
string | The language in which the search results should be returned. It should be one of the TomTom IETF Supported Languages tags, case insensitive. When data in a specified language is not available for a specific field, the default language is used. Default value: NGT
|
boolean | The format of newlines in the formatted address. If Default value: |
| Geopolitical View. The context used to resolve the handling of disputed
territories. Views include Default values:
|
Response data
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 fields section for more information. When requesting JSON output the response has the following structure:
1{2 "summary": {3 "numResults": 1,4 "queryTime": 1765 },6 "addresses": []7}
Each element of the addresses array is in the following format:
1{2 "address": {3 "streetName": "Bryant Street & The Embarcadero",4 "crossStreet": "Bryant Street",5 "municipality": "San Francisco",6 "neighbourhood": "South Beach",7 "countrySecondarySubdivision": "San Francisco",8 "countrySubdivision": "CA",9 "countrySubdivisionName": "California",10 "countrySubdivisionCode": "CA",11 "postalCode": "94111",12 "countryCode": "US",13 "country": "United States",14 "countryCodeISO3": "USA",15 "freeformAddress": "Bryant Street & The Embarcadero, San Francisco, CA 94111",16 "localName": "San Francisco",17 "street": "The Embarcadero"18 },19 "position": "37.787075,-122.3877"20}
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.
Primary fields | |
|---|---|
Field | Description |
object | Summary information about the search that was performed. summary object |
array | Result list, sorted in descending order by score. addresses array |
summary object | |
| Field | Description |
integer | The number of results in the response. |
integer | Time spent on resolving the query. |
addresses array | |
| Field | Description |
object | The structured address for the result. address object |
double (LatLon) | Position of the result in a form of "latitude,longitude" coordinates. Example: |
address object | |
| Field | Description |
string | The street name. |
string | The street being crossed. |
string | Sub / Super City |
string | City / Town |
string | Sub Sub City |
string | Neighbourhood |
string | County |
string | Named Area. |
string | State or Province |
string | Postal Code / Zip Code |
string | Country (Note: This is a two-letter code, not a country name.) |
string | Country name |
string | ISO alpha-3 country code |
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. |
string | An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. |
string | A full name of the first level of a country administrative hierarchy.
This field appears only in case |
string | The street name. |
Default view mapping
Default view is recognized based on the country the request came from.
Country | Default view | Other available views |
|---|---|---|
| Argentina |
|
|
| India |
|
|
| Morocco |
|
|
| Pakistan |
|
|
| Russia |
|
|
| Turkey |
|
|
| China |
|
|
| Others |
|
|
Response codes
The following table contains response codes signifying successful and failed requests to an API server.
Code | Meaning & possible causes |
|---|---|
| OK : The search successfully returned zero or more results. |
| Bad Request : One or more parameters were incorrectly specified. |
| Forbidden Possible causes include:
|
| Method Not Allowed : The HTTP method ( |
| Not Found : The HTTP request method ( |
| Too Many Requests : The API Key is over the QPS (Queries per second) limit. |
| Server Error : The service was unable to process your request. Contact support to resolve the issue. |
Response headers
The following table contains response headers sent back from an API server.
Header | Description |
|---|---|
Ensures that clients implementing the CORS security model are able to access the response from this service. Value: An asterisk | |
Indicates the format of the response, as chosen by the client. Format: Values: |