Information about the address of a location.

Used in Place.address.

Note that while OfflineSearchEngine.suggest and OfflineSearchEngine.suggestByText set all available details, SearchEngine.suggest and SearchEngine.suggestByText set only Address.addressText. Complete address details can be obtained by searching with PlaceIdQuery.

Address type

The options to specify an address query. A AddressQuery.query can consist of parts of an address or full addresses, optionally comma separated. AddressQuery should only be used to search for parts of the address, excluding the POI name. For example, “Invalidenstraße 116, Berlin, Germany” is appropriate, whereas “HERE, Invalidenstraße 116, Berlin, Germany” is not. To be able to include the POI name, use TextQuery instead. SearchOptions.languageCode specifies the language of the AddressQuery.query and determines the preferred language of the results.

Represents a type of area like country, state, city, county, etc.

Contains place details such as contacts, opening hours and some electro vehicle info.

The options to specify a query by categories.

Represents contact information.

Represents the date range when the tariff element is valid. This is typically used to indicate seasonal tariffs or to announce an update to the tariff in advance. It may also be used to indicate spot prices, together with time period. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents the day of the week. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Contains details of a specific place, such as contact information, opening hours and assigned categories.

Represents data related to specific email address.

eMSP (e-Mobility Service Provider) for which the EV station operator has EV roaming agreements. It is only available for online search.

Represents details on the energy supplied at the charging location. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Energy source of EV charging point. EnergyMix contains a list of this representing the energy sources. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents energy source type. EnergySource contains this representing the type of the energy source. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents environmental impact for an environmental impact category. EnergyMix contains an list of this representing the environmental impacts of different categories. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents environmental impacts category of the environmental impact for energy mix. EnvironmentalImpact contains this representing the category of the environmental impact. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents the restriction reason of an EVChargingPool.

Represents the accessibility level of an EVChargingPool.

Represents a connector at the charging point. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents the connector group at the charging location. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents a pairing of an EVSE and its connector(s) that belong to a group. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Duration of the charging session when the tariff element is valid, in seconds. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

An electric vehicle (EV) charging location.

The semantics generally follow the OCPI 2.2.1 standard.

Known EV-specific acronyms:

• EV: Electric Vehicle
• OCPI: Open Charge Point Interface (a standard with a rather wide adoption worldwide, https://evroaming.org/)
• CPO: Charge Point Operator (company that runs the EV charging location)
• eMSP: e-Mobility Service Provider (customer-facing company)
• EVSE: Electric Vehicle Supply Equipment (the actual charger that can charge one car at a time)

A charging location includes a collection of one or more EV supply equipment (EVSE) instances. Typically, the charging location is the exact location of the group of EVSEs, simplified to a single point, but it can also be the entrance of a parking structure which contains these EVSEs. Each EVSE supports more precise position, where applicable.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Optional features that can be requested for EV charging locations. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents the times when the EVSEs at the charging location can be accessed for charging. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents exceptions to the regular opening hours schedule for EV charging locations, such as special closures or extended hours. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Opening hours schedule for EV charging locations, represented by a list of days of the week during which the location is open in the given time periods. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents name and optionally other details about operator, suboperator, or e-Mobility service provider. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Electric vehicle charging pool details.

Tariffs provide detailed pricing information for charging electric vehicles at a specific location. Each tariff describes how costs are calculated based on various factors such as energy consumed, time spent charging, and session duration. Tariffs are typically associated with specific connectors or connector groups, and are only included in the response when relevant data is available and requested. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents the dimension the price component, which determines what is being charged and how:

• time: Price per unit of time spent charging.
• energy: Price per unit of energy consumed during charging.
• flat: One-time fee charged per session.
• parking time: Price per unit of time not charging but parked at the charger.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents a tariff element, which defines how pricing is applied. The associated condition assists the client in selecting the appropriate element for a charging session. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Condition that the charging session needs to meet to apply the tariff element. Tariff elements may include conditions that define when they apply:

• Time of day (e.g., 22:00–06:00)
• Day of week (e.g., weekends only)

• Charging session duration
• Battery level thresholds (e.g., overstay fees)

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents the price component of an EV charging tariff. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents a search option to choose the eMSP or CPO whose tariff should be included in the response. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents the tariff pricing model (adhoc, emsp, or cpo). Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents access restrictions for trucks and light commercial vehicles. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents the category of the vehicle supported at the charging point. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

The method that will be called on the main thread when a search operation in EVSearchEngine has been completed. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Charge Point Operator (CPO) ID uses the Electric Vehicle Supply Equipment ID (EVSE ID) for an exact identification of the charging infrastructure and charging point.

The EVSearchEngine API provides detailed information about charging locations. It requires an online connection to execute the requests. A licence is required to use this API. Details can be found in HERE EV Charge Points API v3 - Developer Guide.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Specifies possible errors that EVSearchEngine may report. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Provides the protocol for the EVSearchEngine. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Encapsulates additional options that control the behavior of EVSearchEngine. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

EVSE connector.

Represents an EVSE at the charging point. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

EVSE status

Represents facility type available at the location. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Contains fuel additive information for generic fuel type.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Defines possible fuel additives that a fuel could contain.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Contains information about a specific fuel station.

Use PlaceCategory.businessAndServicesPetrolGasolineStation to find fuel stations. In the Details of a Place result you can find the associated fuel station information, if any.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Defines possible fuel types provided by a fuel station.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Contains generic fuel type info of fuel station.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

GeoPlace struct represents a location object: such as a country, a city, a point of interest (POI) etc. It can be used for PersonalPlace creation, in order to provide search on custom places.

Specifies members of Suggestion class to which input query can be matched.

Holds information to which part of the text, input query was matched. The first character is denoted by a value of 0.

Represents data related to specific landline phone number.

Contains geographical info about location

Represents data related to specific mobile phone number.

Provides means to populate personal places data source. Also acts as a owner of the collection of personal places. MyPlaces is memory-only object: nothing is persisted and/or sent over the network. Client has full control on how to store personal places.

The OfflineSearchEngine works without internet and unlocks the search and geocoding capabilities of HERE services to provide developers with unmatched flexibility to create differentiating location-enabled applications.

It provides the same interfaces as the SearchEngine, but the results may slightly differ as the results are taken from already downloaded map data instead of initiating a new request to a HERE backend service. This way the data may be, for example, older compared to the data you may receive when using the SearchEngine. On the other hand, this class provides results faster as no online connection is necessary.

In comparison to the SearchEngine, there are a few limitations:

• The IDs of POIs are different and may differ among different map versions.
• The implementation is different and the resources are limited, so the results can differ.
• OfflineSearchEngine sometimes doesn’t return the requested number of results.

Note: You can search only within persistent map data (downloaded via MapDownloader) or existing cached data. However, cached data may be incomplete, which can result in searches returning partial or incomplete information. Therefore, it is recommended to use persistent map data. Make sure that at least LayerConfiguration.Feature.offlineSearch is enabled. For EV rich attributes also enable LayerConfiguration.Feature.ev, for truck rich attributes also enable LayerConfiguration.Feature.truckServiceAttributes, for fuel station rich attributes also enable LayerConfiguration.Feature.fuelStationAttributes in SDKOptions.layerConfiguration.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Protocol to get updates about progress of creating persistent map index.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents opening hours information.

Represents parking type available at the location. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents a location object, such as a country, a city, a point of interest (POI) etc.

Represents a category of place with different levels of granularity. This class also defines a set of most commonly used categories.

Parameters related to HERE Places chain system.

The filter options to specify a place. Consists of fuel, truck and EV options.

Parameters related to HERE Places cuisine system.

The options to specify a Place id query.

The method will be called on the main thread when a search by id call has been completed.

The method will be called on the main thread when a search by id call has been completed.

Represents and error, which occurs during place serialization and deserialization routines.

Place serialization exception

Specifies place type of Place result from a search query.

Details about the payment options at the POI.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Holds constants that represent payment methods.

See POIPaymentDetails for usage.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Structure holding various information received with response to a query.

Encapsulates schedule details complying with the iCalendar specification: https://tools.ietf.org/html/rfc5545.

The method will be called on the main thread when a search call has been completed. The first argument indicates an error in case of a failure. The second argument contains the results. Both arguments cannot be nil at the same time - or not nil at the same time.

The method will be called on the main thread when a search call has been completed. The first argument indicates an error in case of a failure. The second argument contains the results. Both arguments cannot be nil at the same time - or not nil at the same time.

The SearchEngine API unlocks the search, geocoding and suggesting capabilities of HERE services to provide developers with unmatched flexibility to create differentiating location-enabled applications. It enables to search for HERE points of interests, forward and reverse geocode addresses and geographic coordinates from the HERE map and search for suggested addresses or place candidates based on incomplete or misspelled queries.

It also allows to search along a given GeoPolyline set inside a GeoCorridor as part of a TextQuery.

The SearchEngine API requires an online connection to execute the requests.

Note: All methods are provided in two flavors. One uses a SearchCompletionHandler and the other uses a SearchExtendedCompletionHandler: The later adds a ResponseDetails result type that provides the requestId of a search request and a correlationId to identify multiple, related queries. This may be useful for debug purposes.

Specifies possible errors that may result from a search query.

Provides the protocol for the online and offline search engines.

Encapsulates options that control the behavior of search and suggest operations.

The options to specify a structured query. Only supported in OfflineSearchEngine (only available for the Navigate license).

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Suggestion is meant to provide relevant suggestions to partial queries, like “restaur”, “starbu”, “eiffel”. Represents a relevant response to user queries. Suggestions (please check SuggestionType) are either: Place: SuggestionType.place Query: SuggestionType.chain or SuggestionType.category

With “Place” you get data for a concrete place in the world. With “Query” something to follow-up, a way to perform more focused search.

Specifies the type of suggestion returned for query.

The method will be called on the main thread when a suggest call has been completed. The first argument indicates an error in case of a failure. The second argument contains the results. Both arguments cannot be nil at the same time - or not nil at the same time.

The method will be called on the main thread when a suggest call has been completed. The first argument indicates an error in case of a failure. The second argument contains the results. Both arguments cannot be nil at the same time - or not nil at the same time. This API is not supported by offline search.

Identifier of the place as provided by the supplier

The options to specify a text query.

Time period when the tariff element is valid, in local time. The time period wraps around to the next day, when end time of the period TimeOfDayRange.to is smaller than the beginning TimeOfDayRange.from. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Truck amenities struct, represents availability (true/false) for each feature, except shower_count - number of showers, if data is available. Note: This is a BETA feature and thus subject to change.

Contains truck fuel type info of fuel station. Note: This is a BETA feature and thus subject to change.

Contains information about images, editorials, rating and a urls to them.

Contains information about editorial article and a link to it.

Contains image information and direct link to it.

Contains information about rating and a url to review.

Represents data related to specific website address

Contains information about provider of the item and a direct link to the item.

what3words is an alternative geocode system designed to identify any location on the planet. The system divides the world into a grid of 57 trillion 3-by-3-metre squares, each of which has a three-word address. For example, the front door of HERE’s Berlin office is identified by “///wage.mere.heap”. W3WSearchEngine allows you to convert 3 word addresses to coordinates and also coordinates to 3 word addresses.

Note: Using W3WSearchEngine requires a licence to access HERE what3words APIs.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Specifies possible errors that may result from a w3w search query.

Contains information about one of the squares in the what3words geocode system.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

The method that will be called on the main thread when a search operation in W3WSearchEngine has been completed.