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

PricingContact
Search API
Get your key

Category Search

 

Service version: 2
Last edit: 2019.03.28

On this page

Purpose

If your search use case only requires POI (Points of Interest) results filtered by category, you may use the Category Search endpoint. This endpoint will only return POI results which are categorized as specified.

To view the list of available categories, see the following section. Click "Show more" to expand/collapse the list and view its content.

List of available categories (note that this category list is subject to change with a new data release):

"(sub) urban", "access gateway", "administrative area", "administrative division", "adventure sports venue", "adventure vehicle", "advertising/marketing", "afghan", "african", "agricultural school", "agricultural supplies", "agricultural technology", "agriculture", "airfield", "airline", "airline access", "airport", "algerian", "ambulance unit", "american", "amphitheater", "amusement arcade", "amusement park", "amusement place", "anabranch", "animal services", "animal shelter", "antique/art", "apartment", Show more

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>/categorySearch/<query>.<ext>?key=<Your_API_Key>[&typeahead=<typeahead>][&limit=<limit>][&ofs=<ofs>][&lat=<lat>][&lon=<lon>][&countrySet=<countrySet>][&radius=<radius>][&topLeft=<topLeft>][&btmRight=<btmRight>][&language=<language>][&extendedPostalCodesFor=<extendedPostalCodesFor>][&view=<view>]

▲ Return to top

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.
Optional parameters
Parameter Description
[typeahead]
boolean 		If the "typeahead" flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.
Default value: false
[limit]
integer 		Maximum number of responses that will be returned.
Default value: 10
Maximum value: 100
[ofs]
integer 		Starting offset of the returned results within the full result set.
Default value: 0
Maximum value: 1900
[lat]
float 		Latitude, e.g., lat=37.337 lat,lon where results should be biased.
Note: supplying a lat/lon without a radius will only bias the search results to that area.
Value: min/max: -90 to +90
Reference: Latitude, Longitude and Coordinate System Grids
[lon]
float 		Longitude, e.g.,lon=-121.89 lat,lon where results should be biased.
Note: supplying a lat/lon without a radius will only bias the search results to that area.
Value: min/max: -180 to +180
Reference: Latitude, Longitude and Coordinate System Grids
[countrySet]
string 		Comma separated string of country codes (e.g., FR,ES).

  • This will limit the search to the specified countries.
  • The choice of view may restrict which countries are available.

Values: FR,ES,etc.

[radius]
integer 		If radius and position are set, the results will be constrained to the defined area.
The radius parameter is specified in meters.
Value: A radius.
[topLeft]
string (position) 		Top left position of the bounding box.

  • This is specified as a comma separated string composed by lat,lon (e.g., 37.553,-122.453).
  • Important note: Point-Radius parameters and Bounding box parameters are mutually exclusive.
  • Point radius parameters take precedence when both are passed.

Value: A comma separated string.

[btmRight]
string (position) 		Bottom right position of the bounding box.

  • This is specified as a comma separated string composed by lat,lon (e.g., 37.553,-122.453).
  • Important note: Point-Radius parameters and Bounding box parameters are mutually exclusive.
  • Point radius parameters take precedence when both are passed.

Value: A comma separated string.

[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 indexes are:

  • POI = Points of Interest

The value should be "POI" or "None" to disable extended postal codes. By default extended postal codes are included.
Usage examples:

  • extendedPostalCodesFor=POI
  • extendedPostalCodesFor=None

Extended postal code is returned as an extendedPostalCode property of an address. Availability is region-dependent.
Values: POI or None

[categorySet]
string 		A comma-separated list of categories which could be used to restrict the result to Points Of Interest of specific categories. The list of categories can be discovered using Category Tree endpoint.
Value: A comma-separated list of category identifiers (in any order).

  • Item order does not matter.
  • When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned.

Usage examples:

  • categorySet=7315 (search Points Of Interest of category Restaurant)
  • categorySet=7315025,7315017 (search Points Of Interest of category either Italian or French Restaurant)
[brandSet]
string 		A comma-separated list of brand names which could be used to restrict the result to Points Of Interest of specific brands.
Value: A comma-separated list of brand names (in any order).

  • Item order does not matter.
  • When multiple brands are provided, only POIs that belong to (at least) one of the brands from the provided list will be returned.
  • Brands that contain a "," in their name should be put into quotes, for example: "A,B,C Comma".

Usage examples:

  • brandSet=Tomtom (search Points Of Interest of ¨Tomtom¨ brand)
  • brandSet=Tomtom,Foobar (search Points Of Interest of ¨Tomtom¨ brand OR ¨Foobar¨ brand)
  • brandSet=¨A,B,C Comma¨ (search Points Of Interest of ¨A,B,C Comma¨ brand)
[connectorSet]
string 		A comma-separated list of connector types which could be used to restrict the result to Points Of Interest of type Electric Vehicle Station supporting specific connector types. List of supported connector types
Value: A comma-separated list of connector types (in any order).

  • Item order does not matter.
  • When multiple connector types are provided, only POIs that support (at least) one of the connector types from the provided list will be returned.

Usage examples:

  • connectorSet=IEC62196Type2CableAttached (search Points Of Interest of type Electric Vehicle Station supporting IEC62196Type2CableAttached)
  • connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached (search Points Of Interest of type Electric Vehicle Station supporting IEC62196Type2CableAttached or IEC62196Type2Outlet)
[view]
string 		Geopolitical View.

  • The context used to resolve the handling of disputed territories.
  • Views include Unified, along with AR, IL, IN, MA, and PK which are respectively tailored for Argentina, Israel, India, Morocco, and Pakistan.

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": 95,
    "numResults": 10,
    "offset": 0,
    "totalResults": 247458,
    "fuzzyLevel": 1,
    "geoBias": {
      "lat": 36.98844,
      "lon": -121.97483
    }
  },
  "results": []
}
Each element of the results [] array is in the following format:
{
  "type": "POI",
  "id": "US/POI/p0/9033556",
  "score": 5,
  "dist": 0,
  "info": "search:ta:840061001865142-US",
  "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
      }
    }
  ],
  "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 Code
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
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
lon
float 		Longitude

▲ Return to top

HTTP Response codes

The following data 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 data 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
Values: type/subtype is one of:

  • application/json
  • text/javascript
  • text/xml

▲ Return to top