HERE Geocoding and Search API v7

{"openapi":"3.0.0","info":{"title":"Geocoding and Search API v7","version":"7.155","description":"This document describes the Geocoding and Search API.\n\n### \"ALPHA\" & \"BETA\" tags\n\n- API requests parameters and response fields can be tagged with one of the following maturity qualifiers: alpha, beta\n- \"ALPHA\" tagged features are in mid-stage development. They can change or in rare cases be removed.\n  No backward compatibility is guaranteed nor bug service level agreement (SLA) do apply.\n  Customers using ALPHA features are advised not use them in production.\n- \"BETA\" tagged features are in end-stage development. They are backward compatible and can not be removed.\n  They have no major bug, but coverage, quality, performance, or test coverage is not considered final.\n  customers can safely use BETA features in their applications if they accept those limitations and potential behavior refinements.\n\n### \"RESTRICTED\" tag\n\nAPI requests parameters and response fields can be tagged with the privilege qualifier \"RESTRICTED\".\nSuch features are only available to customers having a specific contract with HERE.\nUnauthorized usages are typically leading to a http status code 403.\n\n\n"},"security":[{"Bearer":[]},{"ApiKey":[]}],"externalDocs":{"description":"The developer guide, release notes, and migration guide are available here.","url":"https://www.here.com/docs/category/geocoding-search-v7"},"components":{"securitySchemes":{"Bearer":{"description":"A token obtained from a separate endpoint using client credentials and an OAuth 1.0a HMAC-SHA256 signed request.\nFor more information on how to get a bearer token, see the\n[Identity and Access Management Developer Guide](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/).\n","type":"http","scheme":"bearer","bearerFormat":"JWT"},"ApiKey":{"description":"A key generated specifically to authenticate API requests.\nFor more information on how to get an API key, see the\n[Identity and Access Management Developer Guide](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/).\n","type":"apiKey","name":"apiKey","in":"query"}},"parameters":{"atBrowse":{"name":"at","description":"Specify the center of the search context expressed as coordinates\n\nRequired parameter for endpoints that are expected to rank results by distance from the explicitly\n specified search center\n\nFormat: `{latitude},{longitude}`\n\nType: `{decimal},{decimal}`\n\nExample: `-13.163068,-72.545128` (Machu Picchu Mountain, Peru)\n","in":"query","required":true,"schema":{"type":"string","example":"52.5308,13.3856"}},"qAutocomplete":{"name":"q","description":"Enter a free-text query\n\nExamples:\n * `ber`, `berl`, `berli`, ...\n * `berlin+p`, `berlin+paris`, `berlin+parise`, ...\n * `berlin+pariser+20`\n\n _Note: Whitespace, urls, email addresses, or other out-of-scope queries will yield no results._\n","in":"query","required":true,"schema":{"type":"string","example":"Berlin Pariser 20"}},"qAutosuggest":{"name":"q","description":"Enter a free-text query\n\nExamples:\n * `res`, `rest`, `resta`, `restau`, ...\n * `berlin+bran`, `berlin+brand`, `berlin+branden`, ...\n * `New+Yok+Giants`\n\n _Note: Whitespace, urls, email addresses, or other out-of-scope queries will yield no results.\n","in":"query","required":true,"schema":{"type":"string","example":"Eismieze Berlin"}},"qDiscover":{"name":"q","description":"Enter a free-text query\n\nExamples:\n * `125, Berliner, berlin`\n * `Beacon, Boston, Hospital`\n * `Schnurrbart German Pub and Restaurant, Hong Kong`\n\n _Note: Whitespace, urls, email addresses, or other out-of-scope queries will yield no results.\n","in":"query","required":true,"schema":{"type":"string","example":"Eismieze Berlin"}},"id":{"name":"id","description":"Location ID, is the ID of a result item. For example, a Discover request","in":"query","required":true,"schema":{"type":"string","example":"here:pds:place:276u33db-8097f3194e4b411081b761ea9a366776"}},"addressNamesMode":{"name":"addressNamesMode","description":"This option allows users to choose between displaying normalized or matched address fields in the response,\naffecting the names in the address block, the address label, and the result title.\nThis option is relevant when there is a difference between administrative naming and postal or common naming conventions, or when addressing with alternative street names.\nBy default, geocoding results provide matched names for administrative places and normalized (official) names for street names.\n\nDescription of supported values:\n\n- `matched`: The service returns matched names for address fields.\n- `normalized`: The service returns normalized (primary) names for address fields.","in":"query","explode":false,"required":false,"schema":{"type":"string","enum":["matched","normalized"]}},"addressNamesVariantGeocode":{"name":"addressNamesVariant","description":"The deep‑object parameter enables the API to return different variants of the component names in the GS7 results.\n\n**Note:** When both `addressNamesVariant` and `addressNamesMode` are specified, `addressNamesVariant` takes precedence.\n","in":"query","explode":true,"style":"deepObject","required":false,"schema":{"type":"object","properties":{"city":{"type":"string","enum":["administrative"],"description":"Example:\n\n`addressNamesVariant[city]=administrative`\n\n\nDescription of supported values:\n\n- `administrative`: Returns the administrative name for the selected component in the address result. This option is currently supported **only in the USA**."}}}},"addressNamesVariantLookupRevgeocode":{"name":"addressNamesVariant","description":"The deep‑object parameter enables the API to return different variants of the component names in the GS7 results.","in":"query","explode":true,"style":"deepObject","required":false,"schema":{"type":"object","properties":{"city":{"type":"string","enum":["administrative"],"description":"Example:\n\n`addressNamesVariant[city]=administrative`\n\n\nDescription of supported values:\n\n- `administrative`: Returns the administrative name for the selected component in the address result. This option is currently supported **only in the USA**."}}}},"atAutocompleteGeocode":{"name":"at","description":"Specify the center of the search context expressed as coordinates.\n\nFormat: `{latitude},{longitude}`\n\nType: `{decimal},{decimal}`\n\nExample: `-13.163068,-72.545128` (Machu Picchu Mountain, Peru)\n","in":"query","required":false,"schema":{"type":"string"}},"atAutosuggestDiscover":{"name":"at","description":"Specify the center of the search context expressed as coordinates\n\nFormat: `{latitude},{longitude}`\n\nType: `{decimal},{decimal}`\n\nExample: `-13.163068,-72.545128` (Machu Picchu Mountain, Peru)\n\nThe following constraints apply:\n\n * One of \"at\", \"in=circle\" or \"in=bbox\" is required.\n\n * Parameters \"at\", \"in=circle\" and \"in=bbox\" are mutually exclusive. Only one of them is allowed.\n","in":"query","required":false,"schema":{"type":"string","example":"52.5308,13.3856"}},"atRevgeocode":{"name":"at","description":"Specify the center of the search context expressed as coordinates.\n\nFormat: `{latitude},{longitude}`\n\nType: `{decimal},{decimal}`\n\nExample: `-13.163068,-72.545128` (Machu Picchu Mountain, Peru)\n\nThe following constraints apply:\n\n * Either \"at\" or \"in=circle\" is required.\n\n * Parameters \"at\" and \"in=circle\" are mutually exclusive. Only one of them is allowed.\n","in":"query","required":false,"schema":{"type":"string","example":"52.5308,13.3856"}},"bearing":{"name":"bearing","description":"Takes the \"bearing\" into account for matching nearby street results.\n\nBearing expresses the direction in which an asset is heading in degrees starting at true north and continuing clockwise around the compass.\nNorth is 0 degrees, east is 90 degrees, south is 180 degrees, and west is 270 degrees. Values are expected to be of type Integer.\n\nWhen this parameter is provided, all results will be of type `street`. It is not necessary to provide `types=street` explicitly.\n\nThe following constraints apply:\n\n* If a `types` parameter is provided, the only accepted value is `types=street`.\n\n","in":"query","required":false,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":359,"example":42}},"categories":{"name":"categories","description":"Category filter consisting of a comma-separated list of category-IDs for Categories defined in the HERE Places Category System, described\nin the Appendix to the HERE Search Developer Guide. Places with any assigned categories that match any of the requested categories are\nincluded in the response.\n\nAn exclamation mark \"`!`\" in front of a category ID causes that category to be excluded from the results.\nIt is possible to mix excluded and included categories in the request - e.g. searching for places that are restaurants but not fast food restaurants.\nAn exclusion will always win over an inclusion.\n","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string"}}},"chains":{"name":"chains","description":"Chain filter consisting of a comma-separated list of chain-IDs for Chains defined in the HERE Places Chain System, is described\nin the HERE Search Developer Guide Appendix. Places with any assigned chains that match any of the requested chains are\nincluded in the response.\n\nAn exclamation mark \"`!`\" in front of a chain ID causes that chain to be excluded from the results.\nIt is possible to mix excluded and included chains in the request. For example, searching for results that are Amazon but not Wholefoods.\nAn exclusion will always win over an inclusion.\n","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string"}}},"foodTypes":{"name":"foodTypes","description":"FoodType filter consisting of a comma-separated list of cuisine-IDs for FoodTypes defined in the HERE Places Cuisine System, is described\nin the HERE Search Developer Guide appendix. Places with any assigned foodTypes that match any of the requested foodTypes are\nincluded in the response.\n\nAn exclamation mark \"`!`\" in front of a cuisine ID causes that foodType to be excluded from the results.\nIt is possible to mix excluded and included foodTypes in the request. For example, searching for places that serve italian but not chinese.\nAn exclusion will always win over an inclusion.\n","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string"}}},"fuelStation":{"name":"fuelStation","description":"**BETA**\n\nFuel Station attribute filters.\n\nCombining multiple fuel type query parameters in a request constitutes requiring **at least one** of the specified filter conditions to be satisfied.\n\nExample: `fuelStation[fuelTypes]=biodiesel,ethanol,gasoline`\n","in":"query","explode":true,"style":"deepObject","required":false,"schema":{"type":"object","properties":{"minimumTruckClass":{"type":"string","enum":["heavy","medium"],"description":"**BETA, RESTRICTED**\n\nAll place results returned with a category `700-7600-0116`, `700-7600-0000`, `700-7600-0444`, or `700-7900-0132`\nthat serves truck fuel types with minimum supported truck class specified in this parameter.\nSee the related [Appendix](https://www.here.com/docs/bundle/geocoding-and-search-api-developer-guide/page/topics-places/places-category-system-full.html#700-business-and-services)\nfor details about those place category IDs.\n\nCaution: Note that this filter will be applied to place results regardless of the query intent.\nFor example Places with both a gas station and a grocery category will be returned to a \"grocery\" query\nonly if the place truck classes complies with the values of the query `fuelStation[minimumTruckClass]` values.\n\nDescription of supported values:\n\n- **BETA, RESTRICTED** `heavy`: Medium and Heavy trucks are allowed to fuel in the gas station\n- **BETA, RESTRICTED** `medium`: Only medium size truck is allowed to fuel in the gas station","example":"medium"},"fuelTypes":{"type":"array","items":{"type":"string","enum":["biodiesel","cng","diesel","diesel_with_additives","e10","e20","e85","ethanol","ethanol_with_additives","gasohol_95","gasoline","hvo","hydrogen","lng","lpg","midgrade","octane_100","octane_87","octane_89","octane_90","octane_91","octane_92","octane_93","octane_95","octane_98","premium","premium_with_additives","regular","regular_with_additives","truck_cng","truck_diesel","truck_hydrogen","truck_lng"]},"description":"**BETA, RESTRICTED**\n\nAll place results returned with a category `700-7600-0116`, `700-7600-0000`, `700-7600-0444`, or `700-7900-0132`\nserve at least one fuel type specified in the comma-separated values of this parameter.\nSee the related [Appendix](https://www.here.com/docs/bundle/geocoding-and-search-api-developer-guide/page/topics-places/places-category-system-full.html#700-business-and-services)\nfor details about those place category IDs.\n\nCaution: Note that this filter will be applied to place results regardless of the query intent.\nFor example Places with both a gas station and a grocery category will be returned to a \"grocery\" query\nonly if the place fuel types complies with the values of the query `fuelStation[fuelTypes]` values.\n\nDescription of supported values:\n\n- **BETA, RESTRICTED** `biodiesel`: bio-diesel\n- **BETA, RESTRICTED** `cng`: compressed natural gas (CNG)\n- **BETA, RESTRICTED** `diesel`: diesel\n- **BETA, RESTRICTED** `diesel_with_additives`: diesel with additives\n- **BETA, RESTRICTED** `e10`: E10 (10% ethanol)\n- **BETA, RESTRICTED** `e20`: E20 (20% ethanol)\n- **BETA, RESTRICTED** `e85`: E85 (minimum 70% ethanol blended gasoline)\n- **BETA, RESTRICTED** `ethanol`: ethanol fuel (when specific type is not known, such as E10, E85)\n- **BETA, RESTRICTED** `ethanol_with_additives`: ethanol with additives\n- **BETA, RESTRICTED** `gasohol_95`: E10 (10% Ethanol) with octane 95\n- **BETA, RESTRICTED** `gasoline`: gasoline\n- **BETA, RESTRICTED** `hvo`: hydrotreated vegetable oil fuel\n- **BETA, RESTRICTED** `hydrogen`: hydrogen\n- **BETA, RESTRICTED** `lng`: liquefied natural gas (LNG)\n- **BETA, RESTRICTED** `lpg`: liquefied petroleum gas (LPG)\n- **BETA, RESTRICTED** `midgrade`: midgrade octane rating\n- **BETA, RESTRICTED** `octane_100`: fuel that consists of 100% octane\n- **BETA, RESTRICTED** `octane_87`: fuel that consists of an octane / gasoline blend with 87% octane / 13% gasoline\n- **BETA, RESTRICTED** `octane_89`: fuel that consists of an octane / gasoline blend with 89% octane / 11% gasoline\n- **BETA, RESTRICTED** `octane_90`: fuel that consists of an octane / gasoline blend with 90% octane / 10% gasoline\n- **BETA, RESTRICTED** `octane_91`: fuel that consists of an octane / gasoline blend with 91% octane / 9% gasoline\n- **BETA, RESTRICTED** `octane_92`: fuel that consists of an octane / gasoline blend with 92% octane / 8% gasoline\n- **BETA, RESTRICTED** `octane_93`: fuel that consists of octane / gasoline blend with 93% octane / 7% gasoline\n- **BETA, RESTRICTED** `octane_95`: fuel that consists of an octane / gasoline blend with 95% octane / 5% gasoline\n- **BETA, RESTRICTED** `octane_98`:  fuel that consists of an octane / gasoline blend with 98% octane / 2% gasoline\n- **BETA, RESTRICTED** `premium`: premium octane rating\n- **BETA, RESTRICTED** `premium_with_additives`: premium octane rating with additives\n- **BETA, RESTRICTED** `regular`: regular octane rating\n- **BETA, RESTRICTED** `regular_with_additives`: regular octane rating with additives\n- **BETA, RESTRICTED** `truck_cng`: compressed natural gas (CNG) fuel for truck\n- **BETA, RESTRICTED** `truck_diesel`: diesel fuel for truck\n- **BETA, RESTRICTED** `truck_hydrogen`: hydrogen fuel for truck\n- **BETA, RESTRICTED** `truck_lng`: liquefied natural gas (LNG) fuel for truck","example":["biodiesel","diesel","truck_diesel"]}}}},"inAutocomplete":{"name":"in","description":"Search within a geographic area. This is a hard filter. Results will be returned if they are located within the specified area.\n\nA geographic area can be\n\n * a country (or multiple countries), provided as comma-separated [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country codes\n\n   The country codes must be provided in uppercase.\n\n   Format: `countryCode:{countryCode}[,{countryCode}]*`\n\n   Examples:\n    * `countryCode:USA`\n    * `countryCode:CAN,MEX,USA`\n\n\n * a circular area, provided as latitude, longitude, and radius (in meters)\n\n   Format: `circle:{latitude},{longitude};r={radius}`\n\n   Type: `circle:{decimal},{decimal};r={integer}`\n\n   Example: `circle:52.53,13.38;r=10000`\n\n\n * a bounding box, provided as _west longitude_, _south latitude_, _east longitude_, _north latitude_\n\n   Format: `bbox:{west longitude},{south latitude},{east longitude},{north latitude}`\n\n   Example: `bbox:13.08836,52.33812,13.761,52.6755`\n\n\nThe following constraints apply:\n\n * Parameters \"at\", \"in=circle\" and \"in=bbox\" are mutually exclusive. Only one of them is allowed.\n","in":"query","required":false,"schema":{"type":"string"}},"inAutosuggestDiscover":{"name":"in","description":"Search within a geographic area. This is a hard filter. Results will be returned if they are located within the specified area.\n\nA geographic area can be\n\n * a country (or multiple countries), provided as comma-separated [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country codes\n\n   The country codes must be provided in uppercase.\n\n   Format: `countryCode:{countryCode}[,{countryCode}]*`\n\n   Examples:\n    * `countryCode:USA`\n    * `countryCode:CAN,MEX,USA`\n\n\n * a circular area, provided as latitude, longitude, and radius (in meters)\n\n   Format: `circle:{latitude},{longitude};r={radius}`\n\n   Type: `circle:{decimal},{decimal};r={integer}`\n\n   Example: `circle:52.53,13.38;r=10000`\n\n\n * a bounding box, provided as _west longitude_, _south latitude_, _east longitude_, _north latitude_\n\n   Format: `bbox:{west longitude},{south latitude},{east longitude},{north latitude}`\n\n   Example: `bbox:13.08836,52.33812,13.761,52.6755`\n\n\nThe following constraints apply:\n\n * One of \"at\", \"in=circle\" or \"in=bbox\" is required.\n\n * Parameters \"at\", \"in=circle\" and \"in=bbox\" are mutually exclusive. Only one of them is allowed.\n\n * The \"in=countryCode\" parameter must be accompanied by exactly one of \"at\", \"in=circle\" or \"in=bbox\".\n","in":"query","required":false,"schema":{"type":"string"}},"inBrowse":{"name":"in","description":"Search within a geographic area. This is a hard filter. Results will be returned if they are located within the specified area.\n\nA geographic area can be\n\n * a country (or multiple countries), provided as comma-separated [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country codes\n\n   The country codes must be provided in uppercase.\n\n   Format: `countryCode:{countryCode}[,{countryCode}]*`\n\n   Examples:\n    * `countryCode:USA`\n    * `countryCode:CAN,MEX,USA`\n\n\n * a circular area, provided as latitude, longitude, and radius (in meters)\n\n   Format: `circle:{latitude},{longitude};r={radius}`\n\n   Type: `circle:{decimal},{decimal};r={integer}`\n\n   Example: `circle:52.53,13.38;r=10000`\n\n\n * a bounding box, provided as _west longitude_, _south latitude_, _east longitude_, _north latitude_\n\n   Format: `bbox:{west longitude},{south latitude},{east longitude},{north latitude}`\n\n   Example: `bbox:13.08836,52.33812,13.761,52.6755`\n\n\nThe following constraints apply:\n\n * Parameters \"in=circle\" and \"in=bbox\" are mutually exclusive. Only one of them is allowed.\n","in":"query","required":false,"schema":{"type":"string"}},"inGeocode":{"name":"in","description":"Search within a geographic area. This is a hard filter. Results will be returned if they are located within the specified area.\n\nA geographic area can be\n\n * a country (or multiple countries), provided as comma-separated [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country codes\n\n   The country codes must be provided in uppercase.\n\n   Format: `countryCode:{countryCode}[,{countryCode}]*`\n\n   Examples:\n    * `countryCode:USA`\n    * `countryCode:CAN,MEX,USA`\n\n","in":"query","required":false,"schema":{"type":"string"}},"inRevgeocode":{"name":"in","description":"Search within a geographic area. This is a hard filter. Results will be returned if they are located within the specified area.\n\nA geographic area can be\n\n * a circular area, provided as latitude, longitude, and radius (in meters)\n\n   Format: `circle:{latitude},{longitude};r={radius}`\n\n   Type: `circle:{decimal},{decimal};r={integer}`\n\n   Example: `circle:52.53,13.38;r=10000`\n\n\nThe following constraints apply:\n\n * Either \"at\" or \"in=circle\" is required.\n\n * Parameters \"at\" and \"in=circle\" are mutually exclusive. Only one of them is allowed.\n","in":"query","required":false,"schema":{"type":"string"}},"mobilityMode":{"name":"mobilityMode","description":"This field indicates the mode of mobility used by the end user when interacting with the Search\nservice through the customer application. The information is used to improve the relevance of\nsearch results.\n\nFor example, a search for “EV charging station” will preferentially return charging stations\nsuitable for trucks when the `mobilityMode` field is set to `truck`.\n\nThe `mobilityMode` field accepts a single value.\n\n\nDescription of supported values:\n\n- `car`: A standard motor vehicle primarily designed to transport up to 8 people, rather than cargo.\n- `motorbike`: A two-wheeled vehicle typically used by one or two people, suitable for commuting or long-distance travel.\n- `truck`: A larger vehicle primarily designed for transporting freight.","in":"query","explode":false,"required":false,"schema":{"type":"string","enum":["car","motorbike","truck"]}},"name":{"name":"name","description":"Full-text filter on POI names/titles. Results with a partial match on the name parameter are included in the response.","in":"query","required":false,"schema":{"type":"string"}},"postalCodeMode":{"name":"postalCodeMode","description":"Options to return multiple results in areas where a postal code is associated with more than one district or city area.\nWithout these options, the system only provides one result and may leave the district or city name blank or use a default name,\npotentially omitting relevant districts of cities.\n\nDescription of supported values:\n\n- `cityLookup`: When a postal code spans multiple cities, this option gives you all possible combinations of the postal code with the corresponding city names.\n- `districtLookup`: When a postal code spans multiple districts (within one city or across multiple cities), this option gives you all possible combinations of the postal code with the corresponding district and city names.","in":"query","explode":false,"required":false,"schema":{"type":"string","enum":["cityLookup","districtLookup"]}},"qGeocode":{"name":"q","description":"Enter a free-text query\n\nExamples:\n * `125, Berliner, berlin`\n * `Beacon, Boston, Hospital`\n * `Schnurrbart German Pub and Restaurant, Hong Kong`\n\n_Note: Either `q` or `qq`-parameter is required on this endpoint. Both parameters can be provided in the same request._\n","in":"query","required":false,"schema":{"type":"string","example":"Invalidenstraße 116 Berlin"}},"qq":{"name":"qq","description":"Enter a qualified query. A qualified query is similar to a free-text query, but in a structured manner.\n It can take multiple _sub-parameters_, separated by semicolon, allowing to specify different aspects of a query.\n\nCurrently supported _sub-parameters_ are `country`, `state`, `county`, `city`, `district`, `street`,\n `houseNumber`, and `postalCode`.\n\nFormat: `{sub-parameter}={string}[;{sub-parameter}={string}]*`\n\nExamples:\n * `city=Berlin;country=Germany;street=Friedrichstr;houseNumber=20`\n * `city=Berlin;country=Germany`\n * `postalCode=10969`\n\n_Note: Either `q` or `qq`-parameter is required on this endpoint. Both parameters can be provided in the same request._\n","in":"query","required":false,"schema":{"type":"string"}},"rankingAutosuggestDiscover":{"name":"ranking","description":"**BETA**\n\nSelects the ranking mode to be used.\nThis parameter only applies to places category or chain search use cases (See [discover-use-cases](https://www.here.com/docs/bundle/geocoding-and-search-api-developer-guide/page/topics/endpoint-discover-brief.html#use-cases)).\nIt is ignored for other search use cases.\n\n\nDescription of supported values:\n\n- **BETA** `excursionDistance`: Rank results in along the route parameter by increasing distance\n  from the route polyline.\n\n  Constraint: `ranking=excursionDistance` returns a 400 status code if the `route` parameter is not specified.","in":"query","explode":false,"required":false,"schema":{"type":"string","enum":["excursionDistance"]}},"rankingBrowse":{"name":"ranking","description":"**BETA**\n\nSelects the ranking mode to be used.\nThis parameter only applies to places category, cuisine or chain search use cases (See [browse-category-filter](https://www.here.com/docs/bundle/geocoding-and-search-api-developer-guide/page/topics/endpoint-browse-brief.html#multigranular-place-category-filter)\nand [browse-chain-filter](https://www.here.com/docs/bundle/geocoding-and-search-api-developer-guide/page/topics/endpoint-browse-brief.html#place-chain-filter)).\nIt is ignored for other search use cases.\n\n\nDescription of supported values:\n\n- **BETA** `excursionDistance`: Rank results in along the route parameter by increasing distance\n  from the route polyline.\n\n  Constraint: `ranking=excursionDistance` returns a 400 status code if the `route` parameter is not specified.","in":"query","explode":false,"required":false,"schema":{"type":"string","enum":["excursionDistance"]}},"route":{"name":"route","description":"**BETA**\n\nSelect within a geographic corridor. This is a hard filter. Results will be returned if they are located within the specified area.\n\nA `route` is defined by a [Flexible Polyline Encoding](https://github.com/heremaps/flexible-polyline),\n followed by an optional width, represented by a sub-parameter \"w\".\n\nFormat: `{route};w={width}`\n\nIn regular expression syntax, the values of `route` are formatted as follows:\n\n`[a-zA-Z0-9_-]+(;w=\\d+)?`\n\n\"[a-zA-Z0-9._-]+\" is the encoded flexible polyline.\n\n\"w=\\d+\" is the optional width. The width is specified in meters from the center of the path. If no width is provided, the default is 1000 meters.\n\nType: `{Flexible Polyline Encoding};w={integer}`\n\nThe following constraints apply:\n * A `route` MUST contain at least two points (one segment).\n * A `route` MUST NOT contain more than 2,000 points.\n * A `route` MUST NOT have a width of more than 50,000 meters.\n\nExamples:\n * `BFoz5xJ67i1B1B7PzIhaxL7Y`\n * `BFoz5xJ67i1B1B7PzIhaxL7Y;w=5000`\n * `BlD05xgKuy2xCCx9B7vUCl0OhnRC54EqSCzpEl-HCxjD3pBCiGnyGCi2CvwFCsgD3nDC4vB6eC;w=2000`\n\nNote: The last example above can be decoded (using the Python class [here](https://github.com/heremaps/flexible-polyline/tree/master/python) as follows:\n\n```\n>>> import flexpolyline\n>>> polyline = 'BlD05xgKuy2xCCx9B7vUCl0OhnRC54EqSCzpEl-HCxjD3pBCiGnyGCi2CvwFCsgD3nDC4vB6eC'\n>>> flexpolyline.decode(polyline)\n[(52.51994, 13.38663, 1.0), (52.51009, 13.28169, 2.0), (52.43518, 13.19352, 3.0), (52.41073, 13.19645, 4.0),\n (52.38871, 13.15578, 5.0), (52.37278, 13.1491, 6.0), (52.37375, 13.11546, 7.0), (52.38752, 13.08722, 8.0),\n (52.40294, 13.07062, 9.0), (52.41058, 13.07555, 10.0)]\n```\n","in":"query","required":false,"schema":{"type":"string"}},"termsLimit":{"name":"termsLimit","description":"Maximum number of Query Terms Suggestions to be returned.","in":"query","required":false,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":10}},"typesAutocomplete":{"name":"types","description":"Limit the result items to the specified types.\n\nProvide one of the supported values or a comma separated list.\n\nDescription of supported values:\n\n- `address`: restricting results to result types `houseNumber`, `street`, `postalCodePoint`, `intersection`\n- `area`: restricting results to result types `locality` or `administrativeArea` including all the sub-types\n- `city`: restricting results to result type `locality` and locality type `city`\n- `houseNumber`: restricting results to result type: `houseNumber`, including house number types `PA` (Point Address) and `interpolated`.\n- `postalCode`: restricting results to postal codes: either result type `postalCodePoint` or result type `locality` with locality type `postalCode`.\n\n    Note that in Ireland and Singapore, where each address has unique postal code,\n    `postalCodePoint` results are replaced by `houseNumber` results.\n- `street`: restricting results to result type `street`","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string","enum":["address","area","city","houseNumber","postalCode","street"]}}},"typesGeocode":{"name":"types","description":"A comma-separated list of the types that should be included in the response.\n\nIf this parameter is not set, all types are considered for the response.\n\nDescription of supported values:\n\n- `address`: restricting results to result types `houseNumber`, `street`, `postalCodePoint`, `intersection`, or `addressBlock`\n- `area`: restricting results to result types `locality` or `administrativeArea` including all the sub-types\n- `city`: restricting results to result type `locality` and locality type `city`\n- `houseNumber`: restricting results to result type: `houseNumber`, including house number types `PA` (Point Address), `MPA` (Micro Point Address) and\n  `interpolated`, including exact house number matches and house number fallbacks\n- `place`: restricting results to result type `place`\n- `postalCode`: restricting results to postal codes: either result type `postalCodePoint` or result type `locality` with locality type `postalCode`.\n\n    Note that in Ireland and Singapore, where each address has unique postal code,\n    `postalCodePoint` results are replaced by `houseNumber` results.\n- `street`: restricting results to result type `street`","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string","enum":["address","area","city","houseNumber","place","postalCode","street"]}}},"typesRevgeocode":{"name":"types","description":"Limit the result items to the specified types.\n\nProvide one of the supported values or a comma separated list.\n\nThe following constraints apply:\n\n* If a `bearing` parameter is provided, the `types` parameter will accept `types=street` only.\n\n\nDescription of supported values:\n\n- `address`: restricting results to result types `houseNumber`, `street`, `postalCodePoint`, or `addressBlock`.\n  Result type \"intersection\" is excluded from this list because it is not supported in reverse geocoder.\n- `area`: restricting results to result types `locality` or `administrativeArea` including all the sub-types\n- `city`: restricting results to result type `locality` and locality type `city`\n- `houseNumber`: restricting results to result type: `houseNumber`, including house number types\n  `PA` (Point Address), `MPA` (Micro Point Address) and `interpolated`.\n- `place`: restricting results to result type `place`\n- `street`: restricting results to result type `street`","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string","enum":["address","area","city","houseNumber","place","street"]}}},"withAutocomplete":{"name":"with","description":"Activate certain features or consider specific kinds of results, that would not be active or provided by default.\n\nDescription of supported values:\n\n- **RESTRICTED** `MPA`: Enables the returning of Micro Point Address results. GS7 Autocomplete supports micro point addresses in the following countries: AUS.","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string","enum":["MPA"]}}},"withAutosuggestDiscover":{"name":"with","description":"Activate certain features or consider specific kinds of results, that would not be active or provided by default.\n\nDescription of supported values:\n\n- **ALPHA, RESTRICTED** `recommendPlaces`: The value \"recommendPlaces\" specifies that the endpoint ranks the results of place category search requests according to their importance and prominence, when

# --- truncated at 32 KB (240 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-geocoding-and-search-v7-openapi.json