CrossStreet lookup

Service version: 2
Last edit: 2019.10.29

On this page

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.

1. Go to the TomTom API Explorer page.
2. 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.

Request data

HTTPS Method: GET

URL format

GET https://<baseURL>/search/<versionNumber>/reverseGeocode/crossStreet/<position>.<ext>?key=<Your_API_Key>[&limit=<limit>][&spatialKeys=<spatialKeys>][&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.

▲ Return to top

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 field section for more information.

When requesting JSON output the Response has the following structure:

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

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"
}

Each element of the spatialKeys[] array is in the following format:

{
  "priority": "0",
  "val": "1563238492"
}

▲ 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.

HTTP Response codes

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

▲ Return to top

Response headers

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

▲ Return to Top