Low Bandwidth Search (Deprecated)

Service version: 2
Last edit: 2019.12.18

Deprecation notice

May 1, 2018:

• The Low Bandwidth Search endpoint has been deprecated.
• This endpoint will be withdrawn following a 12 month deprecation period.
• The planned withdrawal date is May 1, 2019.
• Following withdrawal, requests to this endpoint may receive an HTTP 404 error in response.

On this page

Purpose

When building apps for mobile conserving bandwidth is extremely important. We have a shortened endpoint with:

• A more compressed and concise response structure to help save bandwidth.
• Add some convenience to the client side parsing.

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

For ease of viewing and identification:

• Constants and parameters enclosed in angle brackets (< >) must be replaced with their values.
• See the following Request parameters section with the Required and Optional parameters tables for these values.

URL format (using "s" search)

https://<baseURL>/search/<versionNumber>/s/<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>][&idxSet=<idxSet>][&view=<view>]

curl command format (using "s" search)

curl 'https://<baseURL>/search/<versionNumber>/s/<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>][&idxSet=<idxSet>][&view=<view>]'

HTTPS Method: GET

URL format (using "cS" category search)

https://<baseURL>/search/<versionNumber>/cS/<category>.<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>][&idxSet=<idxSet>][&view=<view>]

curl command format (using "cS" category search)

curl 'https://<baseURL>/search/<versionNumber>/cS/<category>.<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>][&idxSet=<idxSet>][&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.

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:

{
  "s": 200,
  "sum": {
    "q": "pizza",
    "t": "NON_NEAR"
  },
  "r": []
}

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

{
  "id": "US/POI/p0/9033556",
  "tp": "POI",
  "etp": "",
  "a1": "2501 Soquel Dr",
  "a2": "Santa Cruz, CA 95065",
  "cc": "US",
  "nm": "Upper Crust Pizza & Pasta",
  "ph": "+(1)-(831)-4762333",
  "ul": "www.uppercrustsc.com/",
  "ps": "36.98844 -121.97483",
  "gh": "9q962ms9k2yx",
  "ct": [
    "pizza",
    "restaurant"
  ],
  "cst": [
    {
      "cd": "RESTAURANT",
      "ns": [
        {
          "nl": "en-US",
          "na": "pizza"
        },
        {
          "nl": "en-US",
          "na": "restaurant"
        }
      ]
    }
  ]
}

▲ 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

HTTP Response codes

▲ Return to top

Response headers

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

▲ Return to top