TomTom Maps for JavaScript
    Preparing search index...

    Function getPOICategories

    • Retrieve the list of POI category types supported by the TomTom Search API.

      The returned code values (POICategory) serve two purposes:

      • Pass to search({ poiCategories }) to filter search results by category.
      • Pass to POIsModule.filterCategories() to filter the map's built-in POI icons. Generic parent codes (e.g. 'RESTAURANT') are supported there; overly specific child codes (e.g. 'ITALIAN_RESTAURANT') are not — use a parent or a POICategoryGroup instead.

      Results are cached in memory per language. The first call fetches from the API; all subsequent calls — including filtered ones — are served from the cache.

      Parameters

      Returns Promise<POICategoriesResponse>

      // All categories
      const { poiCategories: all } = await getPOICategories();

      // Filtered by keyword, merged and deduplicated
      const { poiCategories: gyms } = await getPOICategories({ filters: ['gym'] });
      gyms.forEach(c => console.log(c.code, c.name, c.childCategoryCodes));