TomTom Maps for JavaScript
    Preparing search index...

    Function autocompleteSearch

    • Autocomplete search queries as the user types, enabling faster and more accurate search.

      The Autocomplete service recognizes entities (places, addresses, POIs) within a partial input query and offers them as completion suggestions. This enables real-time search assistance and improves the search experience.

      Parameters

      • params: AutocompleteSearchParams

        Autocomplete parameters including the partial query

      • OptionalcustomTemplate: Partial<AutocompleteSearchTemplate>

        Advanced customization for request/response handling

      Returns Promise<AutocompleteSearchResponse>

      Promise resolving to autocomplete suggestions

      Key features:

      • Real-time suggestions: Returns results as the user types
      • Entity recognition: Identifies addresses, POIs, and geographic areas
      • Structured results: Provides both plain text and structured data
      • Query refinement: Helps users formulate more accurate search queries
      • Fast response: Optimized for low-latency interactive use

      Typical use cases:

      • Search box autocomplete dropdowns
      • Address entry forms
      • Location pickers
      • Navigation apps
      // Autocomplete as user types "amster"
      const suggestions = await autocompleteSearch({
      key: 'your-api-key',
      query: 'amster',
      limit: 5
      });
      // Returns: Amsterdam, Amsterdam Centraal, etc.

      // Autocomplete with position bias
      const localSuggestions = await autocompleteSearch({
      key: 'your-api-key',
      query: 'main st',
      at: [4.9041, 52.3676], // Near Amsterdam
      limit: 10
      });

      // Autocomplete with category filter
      const restaurantSuggestions = await autocompleteSearch({
      key: 'your-api-key',
      query: 'pizz',
      categorySet: [7315], // Restaurant category
      at: [4.9041, 52.3676]
      });