The deep‑object parameter enables the API to return different variants of the component names in the GS7 results.

Select the language to be used for result rendering from a list of BCP 47 compliant language codes.

Select additional fields to be rendered in the response. Please note that some of the fields involve additional webservice calls and can increase the overall response time.

The value is a comma-separated list of the sections to be enabled. For some sections there is a long and a short ID.

Description of supported values:

• countryInfo: For each result item renders additional block with the country info, such as ISO 3166-1 alpha-2 and ISO 3166-1 alpha-3 country code.

• eMobilityServiceProviders: Returns for each place of category EV station (700-7600-0322, 700-7600-0323, 700-7600-0324) the list of e-Mobility Service Providers (eMSP) in extended.evStation field.

• ev: Returns for each place of category EV station (700-7600-0322, 700-7600-0323, 700-7600-0324)

  • connector groups details in extended.evStation field and
  • detailed connectors availability in extended.evAvailability field.

  Please note that the use of this option may impact latency.

• phonemes: Renders phonemes for address and place names into the results.

• postalCodeDetails: For each result item of types postalCodePoint renders block with additional information about this postal code, such as postal code type: ZIP or ZIP+4; ZIP classification code: PO BOX, Unique or military; record type code for ZIP+4 codes. This feature is currently available only in the countries which are using ZIP codes - USA, PRI, VIR, GUM, MNP and ASM.

• referenceCategories: Renders the different place category identifiers associated with the reference information. Example: category identifier 600-6600-0082 (Garden Center) for the Yelp (TM) reference identifier -w_eNjJYsHVkt2UHRc3PDQ

• streetInfo: For each result item renders additional block with the street name decomposed into its parts like the base name, the street type, etc.

• tz: Renders result items with additional time zone information.

• BETA, RESTRICTED fuel: Fetches fuel station related information if available and puts them in the extended.fuelStation field.

• BETA, RESTRICTED fuelPrices: Fetches fuel prices related information if available and puts them in the extended.fuelStation field.

  This option can only be used in combination with fuel or truck. Can also be used with both fuel and truck altogether.

• BETA, RESTRICTED tripadvisor: If available, adds images, ratings, and editorials from Tripadvisor (TM) in the media field of place results.

• BETA, RESTRICTED tripadvisorImageVariants: If available, adds the different image variants from Tripadvisor (TM) in the media field of place results. An image variants are details of the same image in various sizes (thumbnail, small, large, …)

• BETA, RESTRICTED truck: Fetches truck station related information if available and puts the amenities in the extended.truckAmenities field.

• ALPHA, RESTRICTED addressUsage: For each result item with types=houseNumber and houseNumberType=pointAddress, returns a flag indicating whether the address is residential.

Return the map references of the location objects

Description of supported values:

• adminIds: Return the ids for the admin hierarchy of the response, to enable cross referencing into other services or data applications based on HERE Map Content

• cmVersion: Return the core map version number of the region where the result is located

• links: Return the link references from the result's access position, to enable cross referencing into other services or data applications

• RESTRICTED microPointAddress: Return the reference of the micro point address, to enable cross referencing into other services or data applications based on HERE Map Content. This type of reference is only returned by Lookup endpoint or Geocode endpoint.

• pointAddress: Return the reference of the point address, to enable cross referencing into other services or data applications based on HERE Map Content

• segments: Return the street segment references from the result's access position, to enable cross referencing into other services or data applications based on HERE Map Content

  NOTE The previous parameter show=hmcReference is deprecated and replaced by showMapReferences=segments which serves the same purpose.

Return requested additional attributes for segments in a road network if showNavAttributes parameter is specified with valid value and relevant data is available.

The value is a comma-separated list of the sections to be enabled.

Description of supported values:

• access: Return the vehicle types allowed on a road or lane.

• functionalClass: Return the functional class which is used to classify roads depending on the speed, importance and connectivity of the road.

• physical: Return the values to describe special physical characteristics of a road.

• speedLimits: Include speed limit and travel direction of the road in the results where available in content and when requested by the client application.

  Note on speedLimits:

  • The feature is not supported in Japan.
  • This feature is subject to premium pricing. For details, contact your HERE customer representative.

allows enriching some types of response items with related items

Description of supported values:

• RESTRICTED MPA: For type=houseNumber and houseNumberType=PA result items, include a block containing a list of micro point addresses associated to this address, such as buildings, floors (levels) or suites (units). GS7 supports micro point addresses in the following countries: AUS, AUT, CAN, NZL, USA (with the territory of PRI).
• RESTRICTED parentPA: For type=houseNumber and houseNumberType=MPA result items, include a block containing the "parent" point addresses associated with this micro point address. GS7 supports micro point addresses in the following countries: AUS, AUT, CAN, NZL, USA (with the territory of PRI).