Sorry, you need to enable JavaScript to visit this website.

Geometry Search

 

Service version: 2
Last edit: 2019.03.28

On this page

Purpose

The Geometry Search endpoint allows you to perform a free form search inside a single geometry or many of them.

  • The search results that fall inside the geometry/geometries will be returned.
  • To send the geometry you will use a POST or GET request with the JSON as a string value for the geometryList parameter.
  • POST is recommended for all datasets.
  • POST requests require the "Content-Type" header to be set to "application/json".
  • GET can only be used for small datasets.
Option 1. Use a POST Request for all geometry datasets.
Submit the data as a JSON file to the API database using a POST Request.
Note: the geometryList data array is included in the POST body.
{
  "geometryList":[
    {
      "type":"POLYGON",
      "vertices":[
        "37.7524152343544,-122.43576049804686",
        "37.70660472542312,-122.43301391601562",
        "37.712059855877314,-122.36434936523438",
        "37.75350561243041,-122.37396240234374"
      ]
    },
    {
      "type":"CIRCLE",
      "position":"37.71205,-121.36434",
      "radius":6000
    },
    {
      "type":"CIRCLE",
      "position":"37.31205,-121.36434",
      "radius":1000
    }
  ]
}
Option 2. Use a GET Request only for small datasets.
Retreive the data from the API database using a GET Request with the geometryList parameter value set as an array.
?geometryList=[
  {
    "type":"POLYGON",
    "vertices":[
      "37.7524152343544,-122.43576049804686",
      "37.70660472542312,-122.43301391601562",
      "37.712059855877314,-122.36434936523438",
      "37.75350561243041,-122.37396240234374"
    ]
  },
  {
    "type":"CIRCLE",
    "position":"37.71205,-121.36434",
    "radius":6000
  },
  {
    "type":"CIRCLE",
    "position":"37.31205,-121.36434",
    "radius":1000
  }
]

▲ Return to top

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.
  3. Review the Response.

Request data

HTTPS Method: GET

URL format

GET https://<baseURL>/search/<versionNumber>/geometrySearch/<query>.<ext>?key=<Your_API_Key>&geometryList=<geometryList>[&limit=<limit>][&language=<language>][&idxSet=<idxSet>][&extendedPostalCodesFor=<extendedPostalCodesFor>][&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
Base URL for calling the API.
Value: api.tomtom.com
versionNumber
string
Service version number.
Value: The current value is 2.
query
string
Query string. Must be properly URL encoded.
Value: A properly URL encoded query string.
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.
geometryList
object
List of geometries to search in (JSON).

  • Available types are:
    • POLYGON with an array of vertices (lat,lon string)
    • CIRCLE with position (lat,lon string) and radius (in meters)
  • The format is as in the example above.
  • The circle radius unit is in meters.
  • The list (array) can contain up to 50 geometries, each consisting of up to 50 vertices.

Value: A list of geometries. For example:

{
  "type":"POLYGON",
  "vertices":[
    "37.7524152343544,-122.43576049804686",
    "37.70660472542312,-122.43301391601562",
    "37.712059855877314,-122.36434936523438",
    "37.75350561243041,-122.37396240234374"
  ]
},
{
  "type":"CIRCLE",
  "position":"37.71205,-121.36434",
  "radius":6000
}
Optional parameters
Parameter Description
[limit]
integer
The maximum number of responses that will be returned.
Default value: 10
Maximum value: 100
[language]
string
Language in which search results should be returned.

  • Should be one of the TomTom supported IETF language tags, case insensitive.
  • When data in specified language is not available for a specific field, the default langauge is used.

Value: A TomTom supported IETF language tag.

[extendedPostalCodesFor]
string
Indexes for which extended postal codes should be included in the results.

  • Available values are described in additional information indexes abbreviation values section.
  • Value should be a comma-separated list of index types (in any order) or "None" for no indexes.
  • By default, extended postal codes are included for all indexes except Geo.
  • Extended postal code lists for geographies can be quite long, so they have to be explicitly requested when needed.

Usage examples:

  • extendedPostalCodesFor=POI
  • extendedPostalCodesFor=PAD,Addr,POI
  • extendedPostalCodesFor=None

Extended postal code is returned as an extendedPostalCode property of an address. Availability is region-dependent.
Value: A comma-separated list of index types.

[idxSet]
string
The idxSet parameter allows for fine tuning Search by specifying which indexes to utilize for the search. The pre-defined indexes are:

  • Addr = Address range interpolation (when there is no PAD)
  • Geo = Geographies
  • PAD = Point Addresses
  • POI = Points of Interest
  • Str = Streets
  • XStr = Cross Streets (intersections)

Usage examples:

  • idxSet=POI (search Points Of Interest only)
  • idxSet=PAD,Addr (search addresses only)

Values: See the preceding list of pre-defined indexes.

[view]
string
Geopolitical view. The context used to resolve handling disputed territories.

  • Views include Unified, along with IN, PK, IL, MA and AR, which are respectively tailored for India, Pakistan, Israel, Morocco, and Argentina.
  • When this parameter is not used, the defaulting behavior will assign the following views. India: IN, Pakistan: PK, Morocco: MA, Argentina: AR, others: Unified.

Default values:

  • Argentina, default view: AR, available views: Unified, IL, IN, MA, PK
  • India, default view: IN, available views: -
  • Morocco, default view: MA, available views: Unified, AR, IL, IN, PK
  • Pakistan, default view: PK, available views: Unified, AR, IL, IN, MA
  • Others, default view: Unified, available views: AR, IL, IN, MA, PK

▲ 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 documentation for more information.

When requesting JSON output, the Response has the following structure:

{
  "summary": {
    "query": "pizza",
    "queryType": "NON_NEAR",
    "queryTime": 82,
    "numResults": 10,
    "offset": 0,
    "totalResults": 479,
    "fuzzyLevel": 1
  },
  "results": []
}

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

{
  "type": "POI",
  "id": "US/POI/p0/9033556",
  "score": 4,
  "info": "search:ta:840061001865142-US",
  "entityType": "Municipality",
  "poi": {
    "name": "Upper Crust Pizza & Pasta",
    "phone": "+(1)-(831)-4762333",
    "url": "www.uppercrustsc.com/",
    "brands": [
       {
         "name": "Upper Crust"
       }
    ],
    "categorySet": [
       {
         "id": 7315015
       }
    ],
    "categories": [
      "pizza",
      "restaurant"
    ],
    "classifications": [
      {
        "code": "RESTAURANT",
        "names": [
          {
            "nameLocale": "en-US",
            "name": "pizza"
          },
          {
            "nameLocale": "en-US",
            "name": "restaurant"
          }
        ]
      }
    ]
  },
  "address": {
    "streetNumber": "2501",
    "streetName": "Soquel Dr",
    "municipalitySubdivision": "Santa Cruz, Live Oak",
    "municipality": "Santa Cruz, Live Oak",
    "countrySecondarySubdivision": "Santa Cruz",
    "countryTertiarySubdivision": "Santa Cruz",
    "countrySubdivision": "CA",
    "postalCode": "95065",
    "extendedPostalCode": "950652023",
    "countryCode": "US",
    "country": "United States Of America",
    "countryCodeISO3": "USA",
    "freeformAddress": "2501 Soquel Dr, Santa Cruz, CA 95065",
    "countrySubdivisionName": "California"
  },
  "position": {
    "lat": 36.98844,
    "lon": -121.97483
  },
  "viewport": {
    "topLeftPoint": {
      "lat": 36.98934,
      "lon": -121.97596
    },
    "btmRightPoint": {
      "lat": 36.98754,
      "lon": -121.9737
    }
  },
  "entryPoints": [
    {
      "type": "main",
      "position": {
        "lat": 36.98817,
        "lon": -121.97487
      }
    }
  ],
  "addressRanges": {
    "rangeLeft": "1 - 3",
    "rangeRight": "2 - 12",
    "from": {
      "lat": 51.16561,
      "lon": 19.48489
    },
    "to": {
      "lat": 51.16545,
      "lon": 19.4863
    }
  },
  "dataSources": {
    "chargingAvailability": {
      "id": "442009000132285"
    },
    "geometry": {
      "id": "00004e4c-3100-3c00-0000-0000685e23c7"
    }
  }
}

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

Primary fields
Field Description
summary{}
object
Summary information about the search that was performed.
summary{} object
results[]
array
Result list, sorted in descending order by score.
results[] array
summary{} object
Field Description
query
string
Query as interpreted by the search engine.
queryType
string
Response type. Can be NEARBY or NON_NEAR.
queryTime
integer
Time spent on resolving the query.
numResults
integer
Number of Results in the response.
offset
integer
Starting offset of the returned Results within the full Result set.
totalResults
integer
Total number of Results found.
fuzzyLevel
integer
Maximum fuzzy level required to provide Results.
geoBias
comma separated string composed by lat,lon
Position used to bias the Results:
LatLon double
Example: 37.819722,-122.478611
results[] array
Field Description
type
string
Type of Result. One of:

  • POI
  • Street
  • Geography
  • Point Address
  • Address Range
  • Cross Street
id
string
Non-stable id for this Result.
score
double
Score of the Result.
A larger score means there is a probability
that a Result meeting the query criteria is higher.
dist
double
Unit: meters. This is the distance to an object if geobias was provided.
info
string
Information about the original data source of the Result.
entityType
string
Optional section.
Only present if type = = Geography. One of:

  • County
  • CountrySubdivision
  • CountrySecondarySubdivision
  • CountryTertiarySubdivision
  • Municipality
  • MunicipalitySubdivision
  • Neighbourhood
  • PostalCodeArea
poi
object
Optional section. Only present if type == POI.
poi{} object
address
object
Structured address for the Result.
address{} object
position
object
Position of the Result:
LatLon double
Example: 37.819722,-122.478611
viewport
object
A viewport which can be used to display the
Result on a map.
viewport{} object
entrypoints
array
List of entry points of the POI.
entryPoints[] array
addressRanges
object
Address ranges on a street segment.
Available only for Results where the
Result type is equal to "Address Range".
addressRanges{} object
poi{} object
Field Description
name
string
Name of the POI.
phone
string
Telephone number.
brands
array
The list of POI brands.
brands[] array
url
string
Website URL.
categories
array
Deprecated
The list of POI categories.
Category Codes

  • Deprecated: Use classifications instead.
  • As of May 1, 2018:

    • The Response categories field has been deprecated.
    • It will be withdrawn following a 12 month deprecation period.
    • The planned withdrawal date is May 1, 2019.
categorySet
array
The list of the most specific POI categories.
categorySet[] array
classifications
array
The list of POI category classifications.
classifications[] array
categorySet[] array
Field Description
id
number
Category id. Full list of available categories is available under Category Tree endpoint.
brands[] array
Field Description
name
string
Brand name.
classifications[] array
Field Description
code
string
Fixed top level category code. Category Codes
names
array
List of category names with locale code information.
Currently only "en-US" locale is returned.
names[] array
names[] array
Field Description
nameLocale
string
Locale code of this category name.
name
string
Category name in given locale.
address{} object
Field Description
streetNumber
string
The building number on the street.
streetName
string
The street name.
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
extendedPostalCode
string
Extended postal code (availability dependent on region)
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 formatting
rules of a Result's country of origin,or in case
of countries its full country name.
countrySubdivisionName
string
A full name of a first level of country administrative hierarchy.

  • This field appears only in case countrySubdivision is presented in an abbreviated form.
  • Supported only for USA, Canada and Great Britain.
viewport{} object
Field Description
topLeftPoint
comma separated string composed by lat,lon
Top left corner of the rectangle:
LatLon double
btmRightPoint
comma separated string composed by lat,lon
Bottom right corner of the rectangle:
LatLon double
entryPoints[] array
Field Description
type
string
Main entry point: One of:

  • main
  • minor
position
string
Position of the entry point:
LatLon double
Example: 37.819722,-122.478611
addressRanges{} object
Field Description
rangeLeft
string
An address range on the left side of a street segment
(assuming looking from the "from" end toward the "to" end).
rangeRight
string
An address range on the right side of a street segment
(assuming looking from the "from" end toward the "to" end).
from
string
A beginning point of a street segment:
LatLon double
to
string
An end point of a street segment:
LatLon double
dataSources{} object
Field Description
chargingAvailability
object
Information about the charging stations availability. Only present if type == POI.
id
string
Pass this as chargingAvailabilityId to the Additional Data service to fetch charging availability information for this result.
geometry
object
Information about the geometric shape of the result. Only present if type == Geography or POI.
id
string
Pass this as geometryId to the Additional Data service to fetch geometry information for this result.
LatLon
Field Description
lat
float
Latitude. min/max: -90 to +90
Reference: Latitude, Longitude and Coordinate System Grids
lon
float
Longitude. min/max: -180 to +180
Reference: Latitude, Longitude and Coordinate System Grids

▲ Return to top

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
  • Rate or volume limit exceeded
  • 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.
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

Additional information

Indexes abbreviation values

In some cases, list of indexes can be passed as a parameter to query, which should be listed with their abbreviations, available values are:

  • Geo = Geographies - areas on map which represent administrative divison of a land ie. country, state, city.
  • PAD = Point Addresses - points on map where specific address with street name and number can be found in index, ie. Soquel Dr 2501.
  • Addr = Address ranges - for some streets there are address points that are interpolated from the beginning and end of the street, those points are represented as address ranges.
  • Str = Streets - representation of streets on the map.
  • XStr = Cross Streets (intersections) - representations of junctions; places where two streets intersect.
  • POI = Points of Interest - points on map that are worth attention and may be interesting.

▲ Return to Top