Synchronous Batch

Service version: 2

Last edit: 2022.09.26

Purpose

This endpoint allows the submission of a new batch for synchronous processing. It responds with a batch processing result or an HTTP 408 request timeout error, if the processing time exceeds 60 seconds.

Request data

HTTPS method: `POST`

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

post

URL request format

https://{baseURL}/search/{versionNumber}/batch/sync.{outputFormat}?key={Your_API_Key}

URL request example

post

URL request example

https://api.tomtom.com/search/2/batch/sync.json?key={Your_API_Key}

curl command request example

post
curl command request example
1curl -XPOST -d '{
2  "batchItems": [
3    {"query": "/search/lodz.json?limit=10&idxSet=POI,PAD,Str,Xstr,Geo,Addr"},
4    {"query": "/search/wroclaw.json?limit=10&idxSet=POI,PAD,Str,Xstr,Geo,Addr"},
5    {"query": "/search/berlin.json?limit=10&idxSet=POI,PAD,Str,Xstr,Geo,Addr"}
6  ]
7}' 'https://api.tomtom.com/search/2/batch/sync.json?key={Your_API_Key}'

Request parameters

The following table describes the request parameters.

Required parameters must be used or the call will fail.
Optional parameters may be used.
The order of request parameters is not important.

Note: There are no optional parameters in this endpoint.

Required parameters	Description
`baseURL` string	Base URL for calling the API. Values: `api.tomtom.com` `kr-api.tomtom.com` (see the Region-specific content page)
`versionNumber` string	Service version. Value: The current value is `2`.
`key` string	An API Key valid for the requested service. Value: Your valid `API Key`.
`outputFormat` string	The content type of the response structure. Default value: `xml` Other value: `json`

Required parameters

Description

baseURL

string

Base URL for calling the API.

Values:

api.tomtom.com
kr-api.tomtom.com (see the Region-specific content page)

versionNumber

string

Service version.

Value: The current value is 2.

key

string

An API Key valid for the requested service.

Value: Your valid API Key.

outputFormat

string

The content type of the response structure.

Default value: xml

Other value: json

Request headers

The following table describes HTTP request headers of particular interest to Batch Search service clients.

Required headers	Description
Content-Type	Specifies the MIME type of the body of the request. Values: `application/xml` and `application/json`

Required headers

Description

Content-Type

Specifies the MIME type of the body of the request.

Values: application/xml and application/json

Optional headers	Description
Accept-Encoding	Should contain list of encodings acceptable by the client. Usually used to demand a compressed response. Value: `gzip`
Tracking-ID	Specifies an identifier for the request. It can be used to trace a call. The value must match the regular expression `'^[a-zA-Z0-9-]{1,100}$'`. An example of format that matches this regular expression is UUID: (e.g., `9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1` ). For details check RFC 4122.If specified, it is replicated in the Tracking-ID response header. It is only meant to be used for support and does not involve tracking of you or your users in any form. Value: An `identifier` for the request.

Optional headers

Description

Accept-Encoding

Should contain list of encodings acceptable by the client. Usually used to demand a compressed response.

Value: gzip

Tracking-ID

Specifies an identifier for the request. It can be used to trace a call. The value must match the regular expression '^[a-zA-Z0-9-]{1,100}$'. An example of format that matches this regular expression is UUID: (e.g., 9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1 ). For details check RFC 4122.If specified, it is replicated in the Tracking-ID response header. It is only meant to be used for support and does not involve tracking of you or your users in any form.

Value: An identifier for the request.

Supported Search API suite endpoints

A list of Search API suite endpoints supported by the Batch Search service can be found below. For details regarding particular API usage, consult the following respective API documentation pages:

Other API endpoints support

Geocoding API endpoints:
- Geocode
- Structured Geocode
Reverse Geocoding API endpoints:
- Reverse Geocode
- CrossStreet lookup

POST body

The POST body of a batch request should contain a set of items which will be used to execute requests to supported endpoints of the Search API suite. Each batch request can contain items corresponding to multiple supported endpoints of the Search API suite. For each endpoint, the same body structure applies and specific parameters of each endpoint are expected to go into query elements.

post
Request POST body - XML
1<?xml version="1.0" encoding="UTF-8"?>
2<batchRequest>
3  <batchItems>
4    <batchItem>
5      <query>...</query>
6    </batchItem>
7    ...
8    <batchItem>
9      <query>...</query>
10      <post>...</post>
11    </batchItem>
12  </batchItems>
13</batchRequest>

post
Request POST body - JSON
1{
2  "batchItems": [
3    {"query": "..."},
4    ...
5    {
6        "query": "...",
7        "post": {...}
8    }
9  ]
10}

POST body fields

Field	Description
`batchRequest`	Root element of the request.
`batchItems`	A set of batch items. The maximum number of batch items for a Synchronous API is `100`.
`batchItem`	A single batch item.
`query`	A string used to build a request to one of the supported endpoints of the Search API suite. It is a partial URL without protocol, base URL, service version, and API Key. The output format must match the outputFormat parameter of the batch request. If a batch contains any Additional Data service item, the outputFormat parameter value must be set to `json` as the Additional Data service does not support the XML response format. A query must be properly URL-encoded. For example, a Fuzzy Search query "Lodz, Mochnackiego 15/19" should be written as follows (XML format): `<query>/search/Lodz%2C%20Mochnackiego%2015%2F19</query>`. A sample online URL encoder can be found at: URL Encoder. When posting XML to the Batch Search service, the `<query>` element values must be valid XML (e.g., the "&" character must be replaced by the predefined XML entity "&"). More information is in the List of XML character entity references. When posting JSON to the Batch Search service the `<query>` string values must be properly escaped. For example, the " (double-quote) character should be escaped with a `\` (back-slash). More information is available in RFC 7159.
`post`	Contains data that is sent to the Geometry Search or Along Route Search services using the HTTP POST method. These services accept POST data only in JSON format. For batch submissions in XML format, the `<post>` element's value must also be an appropriate JSON object. A JSON object provided in a XML `<post>` element must be valid XML, i.e., it has to be properly XML escaped or wrapped in a CDATA section if necessary.

POST body examples

Mixed endpoint examples

post
Request POST body example - XML
1<?xml version="1.0" encoding="utf-8"?>
2<batchRequest>
<batchItems>
  <batchItem>
    <query>/poiSearch/rembrandt museum.xml</query>
  </batchItem>
  <batchItem>
    <query>/geometrySearch/restaurant.xml?geometryList=[{"type":"CIRCLE","position":"51.5123443,-0.0909851","radius":1000}]</query>
  </batchItem>
  <batchItem>
    <query>/geometrySearch/pizza.xml</query>
    <post>
      {
        "geometryList":[
          {
            "type": "CIRCLE",
            "position": "51.5123443,-0.0909851",
            "radius": 1000
          }
        ]
      }
    </post>
  </batchItem>
  <batchItem>
    <query>/searchAlongRoute/restaurant.xml?maxDetourTime=300</query>
    <post>
      {
        "route": {
          "points": [
            {
              "lat": 37.7524152343544,
              "lon": -122.43576049804686
            },
            {
              "lat": 37.70660472542312,
              "lon": -122.43301391601562
            },
            {
              "lat": 37.712059855877314,
              "lon": -122.36434936523438
            },
            {
              "lat": 37.75350561243041,
              "lon": -122.37396240234374
            }
          ]
        }
      }
    </post>
  </batchItem>
  <batchItem>
    <query>/reverseGeocode/crossStreet/52.4781801,4.8884868.xml</query>
  </batchItem>
  <batchItem>
    <query>/search/lodz.xml?limit=10&amp;idxSet=POI,PAD,Str,Xstr,Geo,Addr</query>
  </batchItem>
</batchItems>
58</batchRequest>

post
Request POST body example - JSON
1{
"batchItems": [
  {"query": "/poiSearch/rembrandt museum.json"},
  {"query": "/geometrySearch/parking.json?geometryList=[{\"type\":\"CIRCLE\",\"position\":\"51.5123443,-0.0909851\",\"radius\":1000}]"},
  {
    "query": "/geometrySearch/pizza.json",
    "post": {
      "geometryList":[
        {
          "type": "CIRCLE",
          "position": "51.5123443,-0.0909851",
          "radius": 1000
        }
      ]
    }
  },
  {
    "query": "/searchAlongRoute/restaurant.json?maxDetourTime=300",
    "post": {
      "route": {
        "points": [
          {
            "lat": 37.7524152,
            "lon": -122.4357604
          },
          {
            "lat": 37.7066047,
            "lon": -122.4330139
          },
          {
            "lat": 37.7120598,
            "lon": -122.3643493
          },
          {
            "lat": 37.7535056,
            "lon": -122.3739624
          }
        ]
      }
    }
  },
  {"query": "/reverseGeocode/crossStreet/52.4829893,4.9247074.json"},
  {"query": "/search/lodz.json?limit=10&idxSet=POI,PAD,Str,Xstr,Geo,Addr&maxFuzzyLevel=2"}
]
45}

Fuzzy Search examples

post
Request POST body example - XML
1<?xml version="1.0" encoding="utf-8"?>
2<batchRequest>
3  <batchItems>
4    <batchItem>
5      <query>/search/lodz.xml?limit=10&amp;idxSet=POI,PAD,Str,Xstr,Geo,Addr</query>
6    </batchItem>
7    <batchItem>
8      <query>/search/wroclaw.xml?limit=10&amp;idxSet=POI,PAD,Str,Xstr,Geo,Addr</query>
9    </batchItem>
10    <batchItem>
11      <query>/search/berlin.xml?limit=10&amp;idxSet=POI,PAD,Str,Xstr,Geo,Addr</query>
12    </batchItem>
13  </batchItems>
14</batchRequest>

post
Request POST body example - JSON
1{
2  "batchItems": [
3    { "query": "/search/lodz.json?limit=10&idxSet=POI,PAD,Str,Xstr,Geo,Addr" },
4    {
5      "query": "/search/wroclaw.json?limit=10&idxSet=POI,PAD,Str,Xstr,Geo,Addr"
6    },
7    { "query": "/search/berlin.json?limit=10&idxSet=POI,PAD,Str,Xstr,Geo,Addr" }
8  ]
9}

POI Search examples

post
Request POST body example - XML
1
2<?xml version="1.0" encoding="utf-8"?>
3<batchRequest>
4  <batchItems>
5    <batchItem>
6      <query>/poiSearch/rembrandt museum.xml</query>
7    </batchItem>
8    <batchItem>
9      <query>/poiSearch/big ben.xml</query>
10    </batchItem>
11    <batchItem>
12      <query>/poiSearch/colosseo.xml</query>
13    </batchItem>
14  </batchItems>
15</batchRequest>

post
Request POST body example - JSON
1{
2  "batchItems": [
3    { "query": "/poiSearch/rembrandt museum.json" },
4    { "query": "/poiSearch/big ben.json" },
5    { "query": "/poiSearch/colosseo.json" }
6  ]
7}

Category Search examples

post
Request POST body example - XML
1<?xml version="1.0" encoding="utf-8"?>
2<batchRequest>
3  <batchItems>
4    <batchItem>
5      <query>/categorySearch/airport.xml?lat=52.229404&amp;lon=21.011422</query>
6    </batchItem>
7    <batchItem>
8      <query>/categorySearch/restaurant.xml?lat=38.925518&amp;lon=76.990957</query>
9    </batchItem>
10    <batchItem>
11      <query>/categorySearch/hotel.xml?lat=34.016308&amp;lon=-118.277123</query>
12    </batchItem>
13  </batchItems>
14</batchRequest>

post
Request POST body example - JSON
1{
2  "batchItems": [
3    { "query": "/categorySearch/airport.json?lat=52.229404&lon=21.011422" },
4    { "query": "/categorySearch/restaurant.json?lat=38.925518&lon=76.990957" },
5    { "query": "/categorySearch/hotel.json?lat=34.016308&lon=-118.277123" }
6  ]
7}

Geometry Search examples

post
Request POST body example - XML
1<?xml version="1.0" encoding="utf-8"?>
2<batchRequest>
<batchItems>
  <batchItem>
    <query>/geometrySearch/restaurant.xml?geometryList=[{"type":"CIRCLE","position":"51.5123443,-0.0909851","radius":1000}]</query>
  </batchItem>
  <batchItem>
    <query>/geometrySearch/pizza.xml</query>
    <post>
      {
        "geometryList":[
          {
            "type": "CIRCLE",
            "position": "51.5123443,-0.0909851",
            "radius": 1000
          }
        ]
      }
    </post>
  </batchItem>
</batchItems>
22</batchRequest>

post
Request POST body example - JSON
1{
"batchItems": [
  {
    "query": "/geometrySearch/parking.json?geometryList=[{\"type\":\"CIRCLE\",\"position\":\"51.5123443,-0.0909851\",\"radius\":1000}]"
  },
  {
    "query": "/geometrySearch/pizza.json",
    "post": {
      "geometryList": [
        {
          "type": "CIRCLE",
          "position": "51.5123443,-0.0909851",
          "radius": 1000
        }
      ]
    }
  }
]
19}

Nearby Search examples

post
Request POST body example - XML
1<?xml version="1.0" encoding="utf-8"?>
2<batchRequest>
3  <batchItems>
4    <batchItem>
5      <query>/nearbySearch/.xml?lat=40.702594&amp;lon=-74.045358&amp;radius=2000</query>
6    </batchItem>
7    <batchItem>
8      <query>/nearbySearch/.xml?lat=41.774831&amp;lon=-87.771554&amp;radius=2000</query>
9    </batchItem>
10    <batchItem>
11      <query>/nearbySearch/.xml?lat=48.141307&amp;lon=17.117647&amp;radius=2000</query>
12    </batchItem>
13  </batchItems>
14</batchRequest>

post
Request POST body example - JSON
1{
2  "batchItems": [
3    { "query": "/nearbySearch/.json?lat=40.702594&lon=-74.045358&radius=2000" },
4    { "query": "/nearbySearch/.json?lat=41.774831&lon=-87.771554&radius=2000" },
5    { "query": "/nearbySearch/.json?lat=48.141307&lon=17.117647&radius=2000" }
6  ]
7}

Along Route Search examples

post
Request POST body example - XML
1<?xml version="1.0" encoding="utf-8"?>
2<batchRequest>
<batchItems>
  <batchItem>
    <query>/searchAlongRoute/restaurant.xml?maxDetourTime=300</query>
    <post>
      {
        "route": {
          "points": [
            {
              "lat": 37.7524152343544,
              "lon": -122.43576049804686
            },
            {
              "lat": 37.70660472542312,
              "lon": -122.43301391601562
            },
            {
              "lat": 37.712059855877314,
              "lon": -122.36434936523438
            },
            {
              "lat": 37.75350561243041,
              "lon": -122.37396240234374
            }
          ]
        }
      }
    </post>
  </batchItem>
  <batchItem>
    <query>/searchAlongRoute/restaurant.xml?maxDetourTime=300</query>
    <post>
      {
        "route": {
          "points": [
            {
              "lat": 48.19871,
              "lon": 16.36319
            },
            {
              "lat": 48.19843,
              "lon": 16.36262
            },
            {
              "lat": 48.19824,
              "lon": 16.36226
            },
            {
              "lat": 48.19788,
              "lon": 16.3615
            }
          ]
        }
      }
    </post>
  </batchItem>
</batchItems>
59</batchRequest>

post
Request POST body example - JSON
1{
"batchItems": [
  {
    "query": "/searchAlongRoute/restaurant.json?maxDetourTime=300",
    "post": {
      "route": {
        "points": [
          {
            "lat": 37.7524152,
            "lon": -122.4357604
          },
          {
            "lat": 37.7066047,
            "lon": -122.4330139
          },
          {
            "lat": 37.7120598,
            "lon": -122.3643493
          },
          {
            "lat": 37.7535056,
            "lon": -122.3739624
          }
        ]
      }
    }
  },
  {
    "query": "/searchAlongRoute/restaurant.json?maxDetourTime=300",
    "post": {
      "route": {
        "points": [
          {
            "lat": 48.19871,
            "lon": 16.36319
          },
          {
            "lat": 48.19843,
            "lon": 16.36262
          },
          {
            "lat": 48.19824,
            "lon": 16.36226
          },
          {
            "lat": 48.19788,
            "lon": 16.3615
          }
        ]
      }
    }
  }
]
54}

Geocode examples

post
Request POST body example - XML
1<?xml version="1.0" encoding="utf-8"?>
2<batchRequest>
3  <batchItems>
4    <batchItem>
5      <query>/geocode/tower bridge.xml</query>
6    </batchItem>
7    <batchItem>
8      <query>/geocode/new york.xml</query>
9    </batchItem>
10    <batchItem>
11      <query>/geocode/amsterdam.xml</query>
12    </batchItem>
13  </batchItems>
14</batchRequest>

post
Request POST body example - JSON
1{
2  "batchItems": [
3    { "query": "/geocode/tower bridge.json" },
4    { "query": "/geocode/new york.json" },
5    { "query": "/geocode/amsterdam.json" }
6  ]
7}

Structured Geocode examples

post
Request POST body example - XML
1<?xml version="1.0" encoding="utf-8"?>
2<batchRequest>
3  <batchItems>
4    <batchItem>
5      <query>/structuredGeocode.xml?countryCode=FR&amp;municipality=Paris&amp;streetName=Avenue de Suffren&amp;streetNumber=70</query>
6    </batchItem>
7    <batchItem>
8      <query>/structuredGeocode.xml?countryCode=ES&amp;municipality=Madrid&amp;streetName=Calle Mariblanca&amp;streetNumber=25</query>
9    </batchItem>
10  </batchItems>
11</batchRequest>

post
Request POST body example - JSON
1{
2  "batchItems": [
3    {
4      "query": "/structuredGeocode.json?countryCode=FR&municipality=Paris&streetName=Avenue de Suffren&streetNumber=70"
5    },
6    {
7      "query": "/structuredGeocode.json?countryCode=ES&municipality=Madrid&streetName=Calle Mariblanca&streetNumber=25"
8    }
9  ]
10}

Reverse Geocode examples

post
Request POST body example - XML
1<?xml version="1.0" encoding="utf-8"?>
2<batchRequest>
3  <batchItems>
4    <batchItem>
5      <query>/reverseGeocode/48.203233,16.360454.xml</query>
6    </batchItem>
7    <batchItem>
8      <query>/reverseGeocode/-26.202878,28.033040.xml</query>
9    </batchItem>
10    <batchItem>
11      <query>/reverseGeocode/12.975469,77.597284.xml</query>
12    </batchItem>
13  </batchItems>
14</batchRequest>

post
Request POST body example - JSON
1{
2  "batchItems": [
3    { "query": "/reverseGeocode/48.203233,16.360454.json" },
4    { "query": "/reverseGeocode/-26.202878,28.033040.json" },
5    { "query": "/reverseGeocode/12.975469,77.597284.json" }
6  ]
7}

CrossStreet lookup examples

post
Request POST body example - XML
1<?xml version="1.0" encoding="utf-8"?>
2<batchRequest>
3  <batchItems>
4    <batchItem>
5      <query>/reverseGeocode/crossStreet/52.4781801,4.8884868.xml</query>
6    </batchItem>
7    <batchItem>
8      <query>/reverseGeocode/crossStreet/12.977194,77.608367.xml</query>
9    </batchItem>
10    <batchItem>
11      <query>/reverseGeocode/crossStreet/21.130272,79.063060.xml</query>
12    </batchItem>
13  </batchItems>
14</batchRequest>

post
Request POST body example - JSON
1{
2  "batchItems": [
3    { "query": "/reverseGeocode/crossStreet/52.4781801,4.8884868.json" },
4    { "query": "/reverseGeocode/crossStreet/12.977194,77.608367.json" },
5    { "query": "/reverseGeocode/crossStreet/21.130272,79.063060.json" }
6  ]
7}

Additional Data examples

post
Request POST body example - XML
1<?xml version="1.0" encoding="utf-8"?>
2<batchRequest>
3  <batchItems>
4    <batchItem>
5      <query>/additionalData.json?geometries=00004631-3400-3c00-0000-0000673c4d2e</query>
6    </batchItem>
7    <batchItem>
8      <query>/additionalData.json?geometries=00004631-3400-3c00-0000-0000673c42fe</query>
9    </batchItem>
10  </batchItems>
11</batchRequest>

The above POST body contains example geometry ID values. Proper geometry ID values can be retrieved from a Search request.

post
Request POST body example - JSON
1{
2  "batchItems": [
3    {
4      "query": "/additionalData.json?geometries=00004631-3400-3c00-0000-0000673c4d2e"
5    },
6    {
7      "query": "/additionalData.json?geometries=00004631-3400-3c00-0000-0000673c42fe"
8    }
9  ]
10}

The above POST body contains example geometry ID values. Proper geometry ID values can be retrieved from a Search request.

EV Charging Stations Availability examples

post
Request POST body example - XML
  <?xml version="1.0" encoding="utf-8"?>
  <batchRequest>
    <batchItems>
      <batchItem>
        <query>/chargingAvailability.xml?chargingAvailability=00112233-4455-6677-8899-aabbccddeeff</query>
      </batchItem>
      <batchItem>
        <query>/chargingAvailability.xml?chargingAvailability=00112233-4455-6677-8899-001122334455</query>
      </batchItem>
    </batchItems>
  </batchRequest>

The above POST body contains example charging availability ID values. Proper charging availability ID values can be retrieved from a Search request.

post
Request POST body example - JSON
1{
2  "batchItems": [
3    {
4      "query": "/chargingAvailability.json?chargingAvailability=00112233-4455-6677-8899-aabbccddeeff"
5    },
6    {
7      "query": "/chargingAvailability.json?chargingAvailability=00112233-4455-6677-8899-001122334455"
8    }
9  ]
10}

The above POST body contains example charging availability ID values. Proper charging availability ID values can be retrieved from a Search request.

Response data

HTTP status codes

Code	Meaning & possible causes
`200`	OK : The batch job has completed. Results are streamed to client.
`400`	Bad Request : Missing required parameters, exceeded maximum number of batch items, or parameters did not pass validation.
`403`	Forbidden : The API Key is missing, inactive, invalid, not entitled to use Batch Search API over QPS (Queries per second) or over QPD (Queries per day). Can also occur when using HTTP instead of HTTPS.
`404`	Not Found : The requested resource could not be found, but it may be available again in the future.
`405`	Method Not Allowed : The client used an HTTP method other than POST.
`408`	Request timeout : The request sent to the server took longer than it was prepared to wait.
`414`	Requested URI is too long : Indicates that the URI requested by the client is longer than the server is willing to interpret.
`429`	Too Many Requests : The API Key is over QPS (Queries per second).
`500`	An error occurred while processing the request. Please try again later.
`502`	Internal network connectivity issue. Please try again later.
`503`	Service currently unavailable. Please try again later.
`504`	Internal network connectivity issue or a request that has taken too long to complete. Please try again later.
`596`	Service not found. Request contains an incorrect FQDN and/or path.

Response headers

The following table lists HTTP response headers of particular interest to the service clients.

Header	Description
Access-Control-Expose-Headers	A comma separated list of HTTP header names that browsers are allowed to access. Value: `Content-Length`
Access-Control-Allow-Origin	A header instructing browsers to allow customer websites to contact the Batch Search service. Value: `*`
Content-Encoding	The Batch Search service applies gzip compression to the responses if it is requested by the client with the Accept-Encoding header. Value: `gzip`
Content-Type	The format of the response as chosen by the client (see the `contentType` request parameter). Values: `application/xml;charset=utf-8` and `application/json;charset=utf-8`.
Tracking-ID	An identifier for the request. If the Tracking-ID header was specified, it is replicated in the response. Otherwise, it is generated automatically by the service. It is only meant to be used for support and does not involve tracking of you or your users in any form. Value: An `identifier` for the request.

Successful response structure

Each Batch response consists of one or more XML <batchItem> elements which correspond sequentially with the <batchItem> elements in the request. Each <batchItem> element contains a successful response from the invoked Search API endpoint or a status code indicating why the batch item failed.

Successful response example - XML
1<?xml version="1.0" encoding="UTF-8"?>
2<batchResponse xmlns="http://api.tomtom.com/batch" formatVersion="0.0.1">
<batchItems>
  <batchItem>
    <statusCode>...</statusCode>
    <response>...</response>
  </batchItem>
  ...
  <batchItem>
    <statusCode>...</statusCode>
    <response>...</response>
  </batchItem>
</batchItems>
<summary>
  <successfulRequests>...</successfulRequests>
  <totalRequests>...</totalRequests>
</summary>
18</batchResponse>

Successful response example - JSON
1{
"formatVersion": "0.0.1",
"batchItems": [
  {
    "statusCode": ...,
    "response": {...}
  },
    ...,
  {
    "statusCode": ...,
    "response": {...}
  }
],
"summary": {
  "successfulRequests": ...,
  "totalRequests": ...
}
18}

Successful response fields

Field	Description
`batchResponse` object	Root element of the batch response.
`successfulRequests` string	Number of successful batch item requests.
`totalRequests` string	Total number of items in batch request.
`batchItems` array	A set of batch items processing results.
`batchItem` object	Contains the results of processing a single batch item.
`statusCode` string	Status code of a response from the underlying Search API endpoint for a given batch item.
`response` object	Content of the response from the underlying Search API endpoint for a given batch item query. The full response content will be included both in case of success and failure. If the underlying service's response content type does not match the requested content type, then the response will be wrapped to fit the requested content type.
`summary` object	Summary of the batch request.

Successful response examples

The following code blocks in XML and JSON contain a complete example of a response to a batch request for three queries to the Fuzzy Search endpoint. Two the batch items were successfully executed resulting in a HTTP 200 response, while one failed with a HTTP 400 error due to the use of an incorrect query parameter. Note that batch success indicates that each batch item was executed, not that each batch item executed successfully.

XML response example

1<?xml version="1.0" encoding="UTF-8"?>
2<batchResponse xmlns="http://api.tomtom.com/batch" formatVersion="0.0.1">
<batchItems>
  <batchItem>
    <statusCode>200</statusCode>
    <response>
      <response>
        <summary>
          <query>lodz</query>
          <queryType>NON_NEAR</queryType>
          <queryTime>95</queryTime>
          <numResults>1</numResults>
          <offset>0</offset>
          <totalResults>363</totalResults>
          <fuzzyLevel>1</fuzzyLevel>
        </summary>
        <results>
          <item>
            <type>Geography</type>
            <id>PL/GEO/p0/4455</id>
            <score>5.98</score>
            <info>search:decarta:ta:616013002038177-PL</info>
            <address>
              <municipality>Lodz</municipality>
              <countrySecondarySubdivision>Łódź</countrySecondarySubdivision>
              <countrySubdivision>Łódzkie</countrySubdivision>
              <countryCode>PL</countryCode>
              <country>Poland</country>
              <countryCodeISO3>POL</countryCodeISO3>
              <freeformAddress>Lodz</freeformAddress>
            </address>
            <position>
              <lat>51.75905</lat>
              <lon>19.4586</lon>
            </position>
          </item>
        </results>
      </response>
    </response>
  </batchItem>
  <batchItem>
    <statusCode>200</statusCode>
    <response>
      <response>
        <summary>
          <query>restaurant amsterdam</query>
          <queryType>NON_NEAR</queryType>
          <queryTime>186</queryTime>
          <numResults>3</numResults>
          <offset>0</offset>
          <totalResults>3731</totalResults>
          <fuzzyLevel>1</fuzzyLevel>
        </summary>
        <results>
          <item>
            <type>POI</type>
            <id>AU/POI/p0/261806</id>
            <score>7.5</score>
            <info>search:decarta:ta:036001105620466-AU</info>
            <poi>
              <name>Nieuw Amsterdam</name>
              <categories>
                <item>restaurant</item>
              </categories>
              <classifications>
                <item>
                  <code>RESTAURANT</code>
                  <names>
                    <item>
                      <nameLocale>en-US</nameLocale>
                      <name>restaurant</name>
                    </item>
                  </names>
                </item>
              </classifications>
            </poi>
            <address>
              <streetNumber>112</streetNumber>
              <streetName>Hardware Street</streetName>
              <municipalitySubdivision>Melbourne CBD</municipalitySubdivision>
              <municipality>Melbourne</municipality>
              <countrySecondarySubdivision>Melbourne</countrySecondarySubdivision>
              <countrySubdivision>Vic</countrySubdivision>
              <postalCode>3000</postalCode>
              <countryCode>AU</countryCode>
              <country>Australia</country>
              <countryCodeISO3>AUS</countryCodeISO3>
              <freeformAddress>Hardware Street 112, Melbourne CBD Melbourne, Vic, 3000</freeformAddress>
            </address>
            <position>
              <lat>-37.8123</lat>
              <lon>144.96068</lon>
            </position>
          </item>
          <item>
            <type>POI</type>
            <id>BE/POI/p0/61115</id>
            <score>7.5</score>
            <info>review:decarta:ta:056001000066087-BE</info>
            <poi>
              <name>Borse van Amsterdam</name>
              <url>www.borsevanamsterdam.be</url>
              <categories>
                <item>belgian</item>
                <item>important tourist attraction</item>
                <item>restaurant</item>
              </categories>
              <classifications>
                <item>
                  <code>RESTAURANT</code>
                  <names>
                    <item>
                      <nameLocale>en-US</nameLocale>
                      <name>belgian</name>
                    </item>
                    <item>
                      <nameLocale>en-US</nameLocale>
                      <name>restaurant</name>
                    </item>
                  </names>
                </item>
                <item>
                  <code>IMPORTANT_TOURIST_ATTRACTION</code>
                  <names>
                    <item>
                      <nameLocale>en-US</nameLocale>
                      <name>important tourist attraction</name>
                    </item>
                  </names>
                </item>
              </classifications>
            </poi>
            <address>
              <streetNumber>26</streetNumber>
              <streetName>Grote Markt</streetName>
              <municipalitySubdivision>Aalst</municipalitySubdivision>
              <municipality>Aalst</municipality>
              <countrySecondarySubdivision>Oost-Vlaanderen</countrySecondarySubdivision>
              <countryTertiarySubdivision>Aalst</countryTertiarySubdivision>
              <countrySubdivision>Vlaams Gewest</countrySubdivision>
              <postalCode>9300</postalCode>
              <countryCode>BE</countryCode>
              <country>Belgium</country>
              <countryCodeISO3>BEL</countryCodeISO3>
              <freeformAddress>Grote Markt 26, 9300 Aalst</freeformAddress>
            </address>
            <position>
              <lat>50.93852</lat>
              <lon>4.03821</lon>
            </position>
          </item>
          <item>
            <type>POI</type>
            <id>BG/POI/p0/11627</id>
            <score>7.5</score>
            <info>search:decarta:ta:100009000014937-BG</info>
            <poi>
              <name>Amsterdam</name>
              <phone>+(359)-(87)-8868962</phone>
              <categories>
                <item>restaurant</item>
              </categories>
              <classifications>
                <item>
                  <code>RESTAURANT</code>
                  <names>
                    <item>
                      <nameLocale>en-US</nameLocale>
                      <name>restaurant</name>
                    </item>
                  </names>
                </item>
              </classifications>
            </poi>
            <address>
              <streetNumber>10</streetNumber>
              <streetName>улица К. Стоилов</streetName>
              <municipalitySubdivision>Plovdiv</municipalitySubdivision>
              <municipality>Пловдив</municipality>
              <countrySecondarySubdivision>Пловдив</countrySecondarySubdivision>
              <postalCode>4000</postalCode>
              <countryCode>BG</countryCode>
              <country>Bulgaria</country>
              <countryCodeISO3>BGR</countryCodeISO3>
              <freeformAddress>улица К. Стоилов 10, 4000 Plovdiv (Пловдив)</freeformAddress>
            </address>
            <position>
              <lat>42.14805</lat>
              <lon>24.7491</lon>
            </position>
          </item>
        </results>
      </response>
    </response>
  </batchItem>
  <batchItem>
    <statusCode>400</statusCode>
    <response>
      <response>
        <errorText>Error parsing 'maxFuzzyLevel': 'asd' is not a valid integer</errorText>
        <message>Error parsing 'maxFuzzyLevel': 'asd' is not a valid integer</message>
        <httpStatusCode>400</httpStatusCode>
      </response>
    </response>
  </batchItem>
</batchItems>
<summary>
  <successfulRequests>2</successfulRequests>
  <totalRequests>3</totalRequests>
</summary>
211</batchResponse>

JSON response example

1{
"formatVersion": "0.0.1",
"batchItems": [
  {
    "statusCode": 200,
    "response": {
      "summary": {
        "query": "lodz",
        "queryType": "NON_NEAR",
        "queryTime": 101,
        "numResults": 1,
        "offset": 0,
        "totalResults": 363,
        "fuzzyLevel": 1
      },
      "results": [
        {
          "type": "Geography",
          "id": "PL/GEO/p0/4455",
          "score": 5.98,
          "info": "search:decarta:ta:616013002038177-PL",
          "address": {
            "municipality": "Lodz",
            "countrySecondarySubdivision": "Łódź",
            "countrySubdivision": "Łódzkie",
            "countryCode": "PL",
            "country": "Poland",
            "countryCodeISO3": "POL",
            "freeformAddress": "Lodz"
          },
          "position": {
            "lat": 51.75905,
            "lon": 19.4586
          }
        }
      ]
    }
  },
  {
    "statusCode": 200,
    "response": {
      "summary": {
        "query": "restaurant amsterdam",
        "queryType": "NON_NEAR",
        "queryTime": 186,
        "numResults": 3,
        "offset": 0,
        "totalResults": 3731,
        "fuzzyLevel": 1
      },
      "results": [
        {
          "type": "POI",
          "id": "AU/POI/p0/261806",
          "score": 7.5,
          "info": "search:decarta:ta:036001105620466-AU",
          "poi": {
            "name": "Nieuw Amsterdam",
            "categories": ["restaurant"],
            "classifications": [
              {
                "code": "RESTAURANT",
                "names": [
                  {
                    "nameLocale": "en-US",
                    "name": "restaurant"
                  }
                ]
              }
            ]
          },
          "address": {
            "streetNumber": "112",
            "streetName": "Hardware Street",
            "municipalitySubdivision": "Melbourne CBD",
            "municipality": "Melbourne",
            "countrySecondarySubdivision": "Melbourne",
            "countrySubdivision": "Vic",
            "postalCode": "3000",
            "countryCode": "AU",
            "country": "Australia",
            "countryCodeISO3": "AUS",
            "freeformAddress": "Hardware Street 112, Melbourne CBD Melbourne, Vic, 3000"
          },
          "position": {
            "lat": -37.8123,
            "lon": 144.96068
          }
        },
        {
          "type": "POI",
          "id": "BE/POI/p0/61115",
          "score": 7.5,
          "info": "review:decarta:ta:056001000066087-BE",
          "poi": {
            "name": "Borse van Amsterdam",
            "url": "www.borsevanamsterdam.be",
            "categories": [
              "belgian",
              "important tourist attraction",
              "restaurant"
            ],
            "classifications": [
              {
                "code": "RESTAURANT",
                "names": [
                  {
                    "nameLocale": "en-US",
                    "name": "belgian"
                  },
                  {
                    "nameLocale": "en-US",
                    "name": "restaurant"
                  }
                ]
              },
              {
                "code": "IMPORTANT_TOURIST_ATTRACTION",
                "names": [
                  {
                    "nameLocale": "en-US",
                    "name": "important tourist attraction"
                  }
                ]
              }
            ]
          },
          "address": {
            "streetNumber": "26",
            "streetName": "Grote Markt",
            "municipalitySubdivision": "Aalst",
            "municipality": "Aalst",
            "countrySecondarySubdivision": "Oost-Vlaanderen",
            "countryTertiarySubdivision": "Aalst",
            "countrySubdivision": "Vlaams Gewest",
            "postalCode": "9300",
            "countryCode": "BE",
            "country": "Belgium",
            "countryCodeISO3": "BEL",
            "freeformAddress": "Grote Markt 26, 9300 Aalst"
          },
          "position": {
            "lat": 50.93852,
            "lon": 4.03821
          }
        },
        {
          "type": "POI",
          "id": "BG/POI/p0/11627",
          "score": 7.5,
          "info": "search:decarta:ta:100009000014937-BG",
          "poi": {
            "name": "Amsterdam",
            "phone": "+(359)-(87)-8868962",
            "categories": ["restaurant"],
            "classifications": [
              {
                "code": "RESTAURANT",
                "names": [
                  {
                    "nameLocale": "en-US",
                    "name": "restaurant"
                  }
                ]
              }
            ]
          },
          "address": {
            "streetNumber": "10",
            "streetName": "улица К. Стоилов",
            "municipalitySubdivision": "Plovdiv",
            "municipality": "Пловдив",
            "countrySecondarySubdivision": "Пловдив",
            "postalCode": "4000",
            "countryCode": "BG",
            "country": "Bulgaria",
            "countryCodeISO3": "BGR",
            "freeformAddress": "улица К. Стоилов 10, 4000 Plovdiv (Пловдив)"
          },
          "position": {
            "lat": 42.14805,
            "lon": 24.7491
          }
        }
      ]
    }
  },
  {
    "statusCode": 400,
    "response": {
      "errorText": "Error parsing 'maxFuzzyLevel': 'asd' is not a valid integer",
      "message": "Error parsing 'maxFuzzyLevel': 'asd' is not a valid integer",
      "httpStatusCode": 400
    }
  }
],
"summary": {
  "successfulRequests": 2,
  "totalRequests": 3
}
201}

Other supported Search API suite responses

For details on a particular supported Search API suite endpoint's response structure, consult the respective API documentation pages available in the supported endpoints section.

Error response

The error response content type depends on the outputFormat parameter.

Error response example - XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<batchResponse xmlns="http://api.tomtom.com/batch" formatVersion="0.0.1">
  <error description="Validation of batch item 1 failed. Batch response format (XML) does not match content type of batch item query."/>
  <detailedError>
    <code>BadRequest</code>
    <message>Bad Request</message>
    <details>
      <detail>
        <code>MalformedBody</code>
        <message>Validation of batch item 1 failed. Batch response format (XML) does not match content type of batch item query.</message>
        <target>postBody</target>
      </detail>
    </details>
  </detailedError>
</batchResponse>

Error response example - JSON

1{
"formatVersion": "0.0.1",
"error": {
  "description": "Validation of batch item 1 failed. Batch response format (JSON) does not match content type of batch item query."
},
"detailedError": {
  "code": "BadRequest",
  "message": "Bad Request",
  "details": {
    "code": "MalformedBody",
    "message": "Validation of batch item 1 failed. Batch response format (JSON) does not match content type of batch item query",
    "target": "postBody"
  }
}
15}

Error response fields

Primary fields
Field	Description
`formatVersion` string	Version of the batch error response format.
`error` object	Simplified information about the error. error object
`detailedError` object	Detailed information about the error. detailedError object
error object
Field	Description
`description` string	A human-readable description of the error. It is intended as an aid to developers and is not suitable for exposure to end users.
detailedError object
Field	Description
`code` string	One of the defined error codes.
`message` string	A human-readable description of the error code. It is intended as an aid to developers and is not suitable for exposure to end users.
`target` string	Optional. Target of the particular error. Values: The name of the request parameter. `postBody`
`details` array	Optional. An array of root causes (more detailed errors) that led to this error. detailedError object
`innerError` object	Optional. A higher level of details about this error. innerError object
innerError object
Field	Description
`code` string	One of the defined error codes.
`message` string	Optional. A human-readable representation of the error code. It is intended as an aid to developers and is not suitable for exposure to end users.
`innerError` object	Optional. A higher level of details about this error. innerError object

Error code hierarchy

List of predefined, hierarchical, human-readable error codes. Top level codes relate to HTTP error codes. They may be refined by error codes in details or innerError. Further levels of refinement are possible by nesting innerError inside innerError. In the future, the list may be extended with additional codes. The application must be ready for the occurrence of an unknown error code (e.g., by stopping error processing at the last understood level of detail).

Error code	Description
`BadArgument`	One of the request parameters was missing or did not pass validation. The `target` field contains the name of the related parameter. Possible inner errors: `MissingRequiredParameter` `InvalidParameterValue` `IllegalParameter`
`BadRequest`	Top level code for requests which resulted in an HTTP `400 Bad Request`. Possible root causes: `BadArgument` and `MalformedBody`.
`BatchRequestTimeout`	Top level code for requests which resulted in an HTTP `408 Request Timeout`. Calculating batch takes too long to complete using sync mode. Please recalculate using async mode.
`IllegalParameter`	Unsupported request parameter was specified.
`InvalidParameterValue`	The value of one of the parameters is invalid.
`InternalServerError`	Top level code for requests which resulted in a HTTP `500 Internal Server Error`. The service cannot handle the request right now, an unexpected condition was encountered.
`MalformedBody`	POST body has unexpected format.
`MissingRequiredParameter`	One of the required parameters was not provided.
`NotFound`	Top level code for requests which resulted in an HTTP `404 Not Found` caused by providing an incorrect request path.
`ServiceUnavailable`	Top level code for requests which resulted in an HTTP `503 Service Unavailable`. The service cannot handle the request right now, this is certainly a temporary state.

Synchronous Batch

Purpose

Request data

HTTPS method: POST

URL request format

URL request example

curl command request example

Request parameters

Request headers

Supported Search API suite endpoints

Other API endpoints support

POST body

POST body fields

POST body examples

Response data

HTTP status codes

Response headers

Successful response structure

Successful response fields

Successful response examples

Other supported Search API suite responses

Error response

Error response fields

Error code hierarchy

HTTPS method: `POST`