Search Protocol Reference


                    
                    
                    search(query:completion:)

This method provides the capability to search places and POIs meeting various criteria.

Important

This is a Public Preview API. It may be changed or removed at any time.

Declaration

Swift

func search(query: SearchQuery, completion: @escaping (Result<SearchResponse, Error>) -> ())

Parameters

`query`	The `SearchQuery` object to limit the results.
`completion`	The completion closure is called after the response to the request has been processed. If no errors occurred, `SearchResponse` contains an array of search results and summary information.


                    
                    
                    autocompleteSearch(query:completion:)

The Autocomplete API enables you to make a more meaningful Search API call by recognizing entities inside an input query and offering them as query terms.

Important

This is a Public Preview API. It may be changed or removed at any time.

Declaration

Swift

func autocompleteSearch(query: AutocompleteQuery, completion: @escaping (Result<AutocompleteResponse, Error>) -> ())

Parameters

`query`	The `AutocompleteQuery`.
`completion`	The completion closure is called after the response to the request has been processed. If no errors occurred, `AutocompleteResponse` contains proposed autocomplete elements, that can be used to implement an input field with the autocomplete feature.


                    
                    
                    searchAlongRoute(query:completion:)

This method allows you to perform a fuzzy search for POIs along a specified route.

Important

This is a Public Preview API. It may be changed or removed at any time.

Declaration

Swift

func searchAlongRoute(query: AlongRouteQuery, completion: @escaping (Result<SearchResponse, Error>) -> ())

Parameters

`query`	The `AlongRouteQuery`.
`completion`	The completion closure is called after the response to the request has been processed. If no errors occurred, `SearchResponse` contains an array of search result and summary information.


                    
                    
                    requestPoiCategories(query:completion:)

This method provides a full list of POI categories and subcategories together with their translations and synonyms. Additional POI category parameters like language can be taken into account using the PoiCategoryQuery.

Important

This is a Public Preview API. It may be changed or removed at any time.

Declaration

Swift

func requestPoiCategories(query: PoiCategoryQuery, completion: @escaping (Result<PoiCategoryResponse, Error>) -> ())

Parameters

`query`	The `PoiCategoryQuery`.
`completion`	The completion closure is called after the response to the request has been processed. If no errors occurred, `PoiCategoryResponse` contains an array of categories and subcategories together with their translations and synonyms.


                    
                    
                    requestPOIDetails(query:completion:)

Provides detailed information about a POI based on its identifier (entityId).

Important

This is a Public Preview API. It may be changed or removed at any time.

Declaration

Swift

func requestPOIDetails(
    query: POIDetailsQuery,
    completion: @escaping (Result<TomTomSDKSearch.POIDetailsResponse, Error>) -> ()
)

Parameters

`query`	a query to describe what POI Details data to request
`completion`	The completion closure is called after the response to the request has been processed. If no errors occurred, `PoiDetailsResponse` contains the requested search result with POI info


                    
                    
                    requestGeometryData(query:completion:)

The Geometries Data Provider returns sets of coordinates that represent the outline of a city, country, or land area. The method supports batch requests of up to 20 identifiers.

query: The query that defines geometries to request.
completion: Parameter completion: The completion closure is called after the response to the request has been processed. If no errors occurred, GeometryDataResponse contains an array of geometries data structures

Important

This is a Public Preview API. It may be changed or removed at any time.

Declaration

Swift

func requestGeometryData(query: GeometryDataQuery, completion: @escaping (Result<GeometryDataResponse, Error>) -> ())


                    
                    
                    requestEvChargingStationsAvailability(query:completion:)

The EV Charging Stations Availability endpoint provides information about the current availability of charging points, grouped by connector type and then power level. The response can be filtered by connector type and a range of charging powers, if provided (using optional request parameters).

Important

This is a Public Preview API. It may be changed or removed at any time.

Declaration

Swift

func requestEvChargingStationsAvailability(
    query: EVChargingStationsAvailabilityQuery,
    completion: @escaping (Result<EVChargingStationsAvailabilityResponse, Error>) -> ()
)

Parameters

`query`	The `EVChargingStationsAvailabilityQuery`. Can be made using `EVChargingStationsAvailabilityQueryBuilder`.
`completion`	Parameter completion: The completion closure is called after the response to the request has been processed. If no errors occurred, `SearchResponse` contains an array of categories and subcategories together with their translations and synonyms.