POI Categories

The POI Categories service endpoint provides a full list of POI categories and subcategories together with their translations and synonyms.

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.

HTTPS Method: GET

URL format

https://<baseURL>/search/<versionNumber>/poiCategories.<ext>?key=<Your_API_Key>&[language=<one_of_the_supported_languages>]

curl command format

curl 'https://<baseURL>/search/<versionNumber>/poiCategories.<ext>?key=<Your_API_Key>&[language=<one_of_the_supported_languages>]'

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.

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

When requesting JSON (json) output format in the Request URL (ext parameter), the Response has the following structure:

{
  "poiCategories": [
    {
      "id": 7320,
      "name": "Sports Center",
      "childCategoryIds": [
        7320002,
        7320003,
        7320004,
        7320006,
        7320005
      ],
      "synonyms": [
        "Fitness Center",
        "Fitness Centre",
        "Fitness Club",
        "Gym",
        "Gymnasium",
        "Health Club",
        "Indoor Sports",
        "Indoors Sports",
        "Sports Centre",
        "Wellness Club"
      ]
    },
    {
      "id": 7374,
      "name": "Stadium",
      "childCategoryIds": [
        7374002,
        7374009,
        7374012,
        7374003,
        7374010,
        7374005,
        7374008,
        7374011,
        7374006,
        7374014,
        7374013,
        7374007,
        7374004
      ],
      "synonyms": [
        "Arena",
        "Gymnasium",
        "Indoor Arena",
        "Sports Field",
        "Sports Ground",
        "Sports Stadium",
        "Sportsfield",
        "Sportsground",
        "Velodrome"
      ]
    },
    . . .
  ]
}

When requesting XML (xml) output format in the Request URL (ext parameter), the Response has the following structure:

<?xml version='1.0' encoding='UTF-8'?>
<response>
 <poiCategories>
   <poiCategory>
    <id>7320</id>
    <name>Sports Center</name>
    <childCategoryIds>
     <childCategoryId>7320002</childCategoryId>
     <childCategoryId>7320003</childCategoryId>
     <childCategoryId>7320005</childCategoryId>
    </childCategoryIds>
    <synonyms>
     <synonym>Gym</synonym>
     <synonym>Health Club</synonym>
     <synonym>Indoors Sports</synonym>
     <synonym>Sports Centre</synonym>
     <synonym>Wellness Club</synonym>
    </synonyms>
   </poiCategory>
   <poiCategory>
    <id>7374</id>
    <name>Stadium</name>
    <childCategoryIds>
     <childCategoryId>7374002</childCategoryId>
     <childCategoryId>7374009</childCategoryId>
     <childCategoryId>7374012</childCategoryId>
     <childCategoryId>7374003</childCategoryId>
     <childCategoryId>7374010</childCategoryId>
     <childCategoryId>7374005</childCategoryId>
     <childCategoryId>7374008</childCategoryId>
     <childCategoryId>7374011</childCategoryId>
     <childCategoryId>7374006</childCategoryId>
     <childCategoryId>7374014</childCategoryId>
     <childCategoryId>7374013</childCategoryId>
     <childCategoryId>7374007</childCategoryId>
     <childCategoryId>7374004</childCategoryId>
    </childCategoryIds>
    <synonyms>
     <synonym>Arena</synonym>
     <synonym>Gymnasium</synonym>
     <synonym>Indoor Arena</synonym>
     <synonym>Sports Field</synonym>
     <synonym>Sports Ground</synonym>
     <synonym>Sports Stadium</synonym>
     <synonym>Sportsfield</synonym>
     <synonym>Sportsground</synonym>
     <synonym>Velodrome</synonym>
    </synonyms>
   </poiCategory>
    ...
 </poiCategories>
</response>

▲ 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

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.