{"openapi":"3.0.0","info":{"title":"Geocoding and Search API v7","version":"7.157","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"},"servers":[{"url":"https://geocode.search.hereapi.com/v1"}],"paths":{"/geocode":{"get":{"summary":"Geocode","description":"This endpoint allows you to find the geo-coordinates of a known address, place, locality or\nadministrative area, even if the query is incomplete or partly incorrect. It also returns a\ncomplete postal address string and address details. It supports structured, unstructured and\nhybrid queries - combinations of structured and unstructured query elements.","parameters":[{"$ref":"#/components/parameters/addressNamesMode"},{"$ref":"#/components/parameters/addressNamesVariantGeocode"},{"$ref":"#/components/parameters/atAutocompleteGeocode"},{"$ref":"#/components/parameters/inGeocode"},{"$ref":"#/components/parameters/postalCodeMode"},{"$ref":"#/components/parameters/qGeocode"},{"$ref":"#/components/parameters/qq"},{"$ref":"#/components/parameters/typesGeocode"},{"$ref":"#/components/parameters/withGeocode"},{"$ref":"#/components/parameters/langAutosuggestBrowseDiscoverGeocodeLookupRevgeocode"},{"$ref":"#/components/parameters/limitGeocode"},{"$ref":"#/components/parameters/politicalView"},{"$ref":"#/components/parameters/showGeocode"},{"$ref":"#/components/parameters/showMapReferencesGeocodeLookupRevgeocode"},{"$ref":"#/components/parameters/showNavAttributes"},{"$ref":"#/components/parameters/showRelatedGeocode"},{"$ref":"#/components/parameters/showTranslations"},{"$ref":"#/components/parameters/X-Request-ID"}],"responses":{"200":{"description":"The search results.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenSearchGeocodeResponse"}}}},"400":{"description":"Client error: request failed validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Client error: http method not supported.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Client error: Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Temporary server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"parameters":{"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**."}}}},"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"}},"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"}},"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"}},"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"]}}},"withGeocode":{"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 supports micro point addresses in the following countries: AUS, AUT, BRA, CAN, NZL, USA (with the territory of PRI).","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string","enum":["MPA"]}}},"langAutosuggestBrowseDiscoverGeocodeLookupRevgeocode":{"name":"lang","description":"Select the language to be used for result rendering from a list of [BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) compliant language codes.","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string"}}},"limitGeocode":{"name":"limit","description":"Maximum number of results to be returned.","in":"query","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":20}},"politicalView":{"name":"politicalView","description":"Toggle the political view.\n\nThis parameter accepts a single ISO 3166-1 alpha-3 country code in all uppercase.\n\nIf a valid 3-letter country code is provided for which GS7 does not have a dedicated political view, it will fallback to the default view.\n\nThe following political views are currently supported:\n\n- `ARG`: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands\n- `EGY`: Egypt's view on Bir Tawil\n- `IND`: India's view on Gilgit-Baltistan\n- `KEN`: Kenya's view on the Ilemi Triangle\n- `MAR`: Morocco's view on Western Sahara\n- `PAK`: Pakistan's view on Jammu and Kashmir and the Junagadh Area\n- `RUS`: Russia's view on Crimea\n- `SDN`: Sudan's view on the Halaib Triangle\n- `SRB`: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands\n- `SUR`: Suriname's view on the Courantyne Headwaters and Lawa Headwaters\n- `SYR`: Syria's view on the Golan Heights\n- `TUR`: Turkey's view on Cyprus and Northern Cyprus\n- `TZA`: Tanzania's view on Lake Malawi\n- `URY`: Uruguay's view on Rincon de Artigas\n- `VNM`: Vietnam's view on the Paracel Islands and Spratly Islands","in":"query","required":false,"schema":{"type":"string"}},"showGeocode":{"name":"show","description":"Select additional fields to be rendered in the response.\nPlease note that some of the fields involve additional webservice calls and can increase the overall response time.\n\nThe value is a comma-separated list of the sections to be enabled.\nFor some sections there is a long and a short ID.\n\nDescription of supported values:\n\n- `countryInfo`: For each result item renders additional block with the country info, such as\n  [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) and\n  [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code.\n- `parsing`: Adds to each result item a `parsing` block with information about how the request query\n  was interpreted. The block lists recognized address elements, including matched fields and\n  additional parsed terms (for example, secondary units), and for each of them provides the\n  value and the position of the corresponding terms in the input query.\n- `postalCodeDetails`: For each result item of types `postalCodePoint` renders block with additional information about this postal code,\n  such as postal code type: ZIP or ZIP+4; ZIP classification code: PO BOX, Unique or military; record type code for ZIP+4 codes.\n  This feature is currently available only in the countries which are using ZIP codes - USA, PRI, VIR, GUM, MNP and ASM.\n- `secondaryUnitInfo`: For each matched unit designator, the geocode endpoint returns an additional block\n  containing the normalized unit type and unit value. GS7 geocode currently supports\n  normalized secondary unit info in the following countries:\n  AUS, AUT, BRA, CAN, ESP, FRA, GBR, HKG, IDN, IND, MEX, NZL, TUR, TWN, USA (with the territory of PRI).\n- `streetInfo`: For each result item renders additional block with the street name decomposed into its parts like the base name, the street type, etc.\n- `tz`: Renders result items with additional time zone information.\n- **ALPHA, RESTRICTED** `addressUsage`: For each result item with `types=houseNumber` and `houseNumberType=pointAddress`, returns a flag indicating whether the address is residential.","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string","enum":["addressUsage","countryInfo","parsing","postalCodeDetails","secondaryUnitInfo","streetInfo","tz"]}}},"showMapReferencesGeocodeLookupRevgeocode":{"name":"showMapReferences","description":"Return the map references of the location objects\n\nDescription of supported values:\n\n- `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\n- `cmVersion`: Return the core map version number of the region where the result is located\n- `links`: Return the link references from the result's access position,\n  to enable cross referencing into other services or data applications\n- **RESTRICTED** `microPointAddress`: Return the reference of the micro point address,\n  to enable cross referencing into other services or data applications\n  based on HERE Map Content. This type of reference is only returned by Lookup endpoint or Geocode endpoint.\n- `pointAddress`: Return the reference of the point address,\n  to enable cross referencing into other services or data applications\n  based on HERE Map Content\n- `segments`: Return the street segment references from the result's access position,\n  to enable cross referencing into other services or data applications\n  based on HERE Map Content\n\n    **NOTE** The previous parameter `show=hmcReference` is deprecated and replaced\n    by `showMapReferences=segments` which serves the same purpose.","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string","enum":["adminIds","cmVersion","links","microPointAddress","pointAddress","segments"]}}},"showNavAttributes":{"name":"showNavAttributes","description":"Return requested additional attributes for segments in a road network if `showNavAttributes` parameter is specified with valid value and relevant data is available.\n\nThe value is a comma-separated list of the sections to be enabled.\n\nDescription of supported values:\n\n- `access`: Return the vehicle types allowed on a road or lane.\n- `functionalClass`: Return the functional class which is used to classify roads depending on the speed, importance and connectivity of the road.\n- `physical`: Return the values to describe special physical characteristics of a road.\n- `speedLimits`: Include speed limit and travel direction of the road in the results where available in content and when requested by the client application.\n\n  Note on `speedLimits`:\n  - The feature is not supported in Japan.\n  - This feature is subject to premium pricing. For details, contact your HERE customer representative.","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string","enum":["access","functionalClass","physical","speedLimits"]}}},"showRelatedGeocode":{"name":"showRelated","description":"allows enriching some types of response items with related items\n\nDescription of supported values:\n\n- **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, BRA, CAN, NZL, USA (with the territory of PRI).\n- `intersections`: For street and house number results, include a block containing a list of intersections nearest to the address.\n- **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, BRA, CAN, NZL, USA (with the territory of PRI).","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string","enum":["MPA","intersections","parentPA"]}}},"showTranslations":{"name":"showTranslations","description":"Shows translations and alternative names of the provided fields in all available languages.\n\nThis parameter accepts comma separated list of allowed fields for which translations are required.\n\nDescription of supported values:\n\n- `city`: shows alternative names and translations available for address field `city`\n- `county`: shows alternative names and translations available for address field `county`\n- `district`: shows alternative names and translations available for address field `district`\n- `state`: shows alternative names and translations available for address field `state`","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string","enum":["city","county","district","state"]}}},"X-Request-ID":{"name":"X-Request-ID","description":"Used to correlate requests with their responses within a customer's application, for logging and error reporting.\n\nFormat: Free string, but a valid UUIDv4 is recommended.","in":"header","required":false,"schema":{"type":"string"}}},"schemas":{"OpenSearchGeocodeResponse":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/GeocodeResultItem"}]},"description":"The results are presented as a JSON list of candidates in ranked order (most-likely to least-likely) based on the matched location criteria."}}},"ErrorResponse":{"type":"object","required":["status","title","correlationId","requestId"],"properties":{"status":{"type":"integer","format":"int32","description":"The HTTP status code"},"title":{"type":"string","description":"Human-readable error description"},"code":{"type":"string","description":"Error code"},"cause":{"type":"string","description":"Human-readable explanation for the error"},"action":{"type":"string","description":"Human-readable action for the user"},"correlationId":{"type":"string","description":"Auto-generated ID univocally identifying this request"},"requestId":{"type":"string","description":"Request identifier provided by the user"}}},"GeocodeResultItem":{"type":"object","required":["title","id","address"],"properties":{"title":{"type":"string","description":"The localized display name of this result item."},"id":{"type":"string","description":"The unique identifier for the result item. This ID can be used for a Look Up by ID search as well."},"politicalView":{"type":"string","description":"ISO3 country code of the item political view (default for international). This response element is populated when the politicalView parameter is set in the query"},"resultType":{"type":"string","enum":["addressBlock","administrativeArea","houseNumber","intersection","locality","place","postalCodePoint","street"],"description":"\nType of the result item.\n\nNote: `addressBlock` result item is either a block or subblock.\n\n`resultType` values can get added to the list without further notice.\n"},"houseNumberType":{"type":"string","enum":["MPA","PA","interpolated"],"description":"Indicates the address type which affects the precision of the address and the coordinate accuracy.\n\nDescription of supported values:\n\n- **RESTRICTED** `MPA`: A Micro Point Address represents a secondary address for a Point\n  Address; for example, building, floor (level) and suite (unit).\n  Micro Point Addresses can be used to enhance Point Address with\n  greater address detail and higher coordinate accuracy. This result\n  type is only returned by Lookup, Geocode, Autocomplete or (Multi) Reverse Geocode endpoints when\n  `with=MPA` parameter is provided.\n- `PA`: A Point Address represents an individual address as a point object.\n  Point Addresses are coming from trusted sources. There is a\n  high certainty that the address exists at that position. A\n  Point Address result contains two types of coordinates. One is the\n  access point (or navigation coordinates), which is the point to\n  start or end a drive. The other point is the position or display\n  point. This point varies per source and country. The point can be\n  the rooftop point, a point close to the building entry, or a point\n  close to the building, driveway or parking lot that belongs to the\n  building.\n- `interpolated`: An interpolated address. These are approximate positions as a\n  result of a linear interpolation based on address ranges. Address\n  ranges, especially in the USA, are typical per block. For\n  interpolated addresses, we cannot say with confidence that the\n  address exists in reality. But the interpolation provides a good\n  location approximation that brings people in most use cases close\n  to the target location. The access point of an interpolated address\n  result is calculated based on the address range and the road\n  geometry. The position (display) point is pre-configured offset\n  from the street geometry. Compared to Point Addresses, interpolated\n  addresses are less accurate."},"addressUsage":{"allOf":[{"$ref":"#/components/schemas/AddressUsage"}],"description":"**ALPHA, RESTRICTED**"},"addressBlockType":{"type":"string","enum":["block","subblock"],"description":"\nType of the address block result if the `resultType` field is set to `addressBlock`.\n\n`addressBlockType` values can get added to the list without further notice.\n"},"localityType":{"type":"string","enum":["city","district","postalCode","subdistrict"],"description":"\nType of the locality result if the `resultType` field is set to `locality`.\n\n`localityType` values can get added to the list without further notice.\n"},"administrativeAreaType":{"type":"string","enum":["country","county","state"],"description":"\nType of the administrative area result if the `resultType` field is set to `administrativeArea`.\n\n`administrativeAreaType` values can get added to the list without further notice.\n"},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Postal address of the result item."},"postalCodeDetails":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PostalCodeDetails_JapanPost"},{"$ref":"#/components/schemas/PostalCodeDetails_Usps_Zip"},{"$ref":"#/components/schemas/PostalCodeDetails_Usps_ZipPlus4"}]},"description":"Additional information for `postalCodePoint` results (only rendered if `show=postalCodeDetails` is\nprovided and only in the countries which are using ZIP codes - USA, PRI, VIR, GUM, MNP, ASM and JPN)"},"position":{"allOf":[{"$ref":"#/components/schemas/DisplayResponseCoordinate"}],"description":"The coordinates (latitude, longitude) of a pin on a map corresponding to the searched place."},"access":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/BasicAccessPoint"}]},"description":"Coordinates of the response item on a HERE map navigable link (for example, for driving or walking)."},"distance":{"type":"integer","format":"int64","description":"The distance \"as the crow flies\" from the search center to this result item in meters.\nFor example: \"172039\"","example":172039},"mapView":{"allOf":[{"$ref":"#/components/schemas/MapView"}],"description":"The bounding box enclosing the geometric shape (area or line) that an individual result covers. `place` typed results have no `mapView`."},"categories":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Category"}]},"description":"The list of categories assigned to this place."},"foodTypes":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Category"}]},"description":"The list of food types assigned to this place."},"houseNumberFallback":{"type":"boolean","description":"If true, indicates that the requested house number was corrected to match the nearest known house number. This field is visible only when the value is true."},"estimatedPointAddress":{"type":"boolean","description":"If true, indicates that the coordinates of `position` and `access` points of the Point Address are\nestimated.\nThis field is visible only for result items with resultType `houseNumber` and houseNumberType `PA` and\nonly when the value is `true`"},"timeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneInfo"}],"description":"Provides time zone information for this place. (rendered only if `show=tz` is provided.)"},"scoring":{"allOf":[{"$ref":"#/components/schemas/Scoring"}],"description":"Indicates for each result how good the result matches to the original query. This can be used by the\ncustomer application to accept or reject the results depending on how \"expensive\" is the mistake for\ntheir use case"},"parsing":{"allOf":[{"$ref":"#/components/schemas/Parsing"}],"description":"Parsed terms and their positions in the input query (only rendered if `show=parsing` is provided.)"},"streetInfo":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/StreetInfo"}]},"description":"Street Details (only rendered if `show=streetInfo` is provided.)"},"countryInfo":{"allOf":[{"$ref":"#/components/schemas/CountryInfo"}],"description":"Country Details (only rendered if `show=countryInfo` is provided.)"},"translations":{"allOf":[{"$ref":"#/components/schemas/TranslationsGeocode"}],"description":"Features all name translations and alternative names for requested address fields."},"mapReferences":{"allOf":[{"$ref":"#/components/schemas/MapReferenceSection"}],"description":"Return the map references of the location objects."},"related":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/RelatedAddress"}]},"description":"List of related objects"},"navigationAttributes":{"allOf":[{"$ref":"#/components/schemas/NavigationAttributes"}],"description":"Return requested additional attributes for segments in a road network if `showNavAttributes` parameter\nis specified with valid value and relevant data is available. The value is a comma-separated list\nof the sections to be enabled."},"secondaryUnitInfo":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/SecondaryUnitInfo"}]},"description":"Secondary unit designator and unit value for each secondary unit recognized in the query in normalized country specific form (only returned if `show=secondaryUnitInfo` is provided.)"}}},"AddressUsage":{"type":"object","required":["usageType"],"properties":{"usageType":{"type":"string","enum":["nonResidential","residential"],"description":"A flag specifying whether the address is residential. (only rendered if `show=addressUsage` is provided.)"}}},"Address":{"type":"object","properties":{"label":{"type":"string","description":"Assembled address value built out of the address components according to the regional postal rules.\nThese are the same rules for all endpoints. It may not include all the input terms. For example:\n\"Schulstraße 4, 32547 Bad Oeynhausen, Germany\""},"countryCode":{"type":"string","description":"A three-letter country code. For example: \"DEU\""},"countryName":{"type":"string","description":"The localised country name. For example: \"Deutschland\""},"stateCode":{"type":"string","description":"A state code or state name abbreviation – country specific. For example, in the United States it is the two letter state abbreviation: \"CA\" for California."},"state":{"type":"string","description":"The state division of a country. For example: \"North Rhine-Westphalia\""},"countyCode":{"type":"string","description":"A county code or county name abbreviation – country specific. For example, for Italy it is the province abbreviation: \"RM\" for Rome."},"county":{"type":"string","description":"A division of a state; typically, a secondary-level administrative division of a country or equivalent."},"city":{"type":"string","description":"The name of the primary locality of the place. For example: \"Bad Oyenhausen\""},"district":{"type":"string","description":"A division of city; typically an administrative unit within a larger city or a customary name of a city's neighborhood. For example: \"Bad Oyenhausen\""},"subdistrict":{"type":"string","description":"A subdivision of a district. For example: \"Minden-Lübbecke\""},"street":{"type":"string","description":"Name of street. For example: \"Schulstrasse\""},"streets":{"type":"array","items":{"type":"string"},"description":"Names of streets in case of intersection result. For example: [\"Friedrichstraße\",\"Unter den Linden\"]"},"block":{"type":"string","description":"Name of block."},"subblock":{"type":"string","description":"Name of sub-block."},"postalCode":{"type":"string","description":"An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code. For example: \"32547\""},"houseNumber":{"type":"string","description":"House number. For example: \"4\""},"building":{"type":"string","description":"Name of building."},"unit":{"type":"string","description":"Secondary unit information. It may include building, floor (level), and suite (unit) details. This field is returned by Geocode, Autocomplete, (Multi) Reverse Geocode and Lookup endpoints only."}}},"PostalCodeDetails_JapanPost":{"type":"object","required":["postalCode"],"properties":{"postalCode":{"type":"string","description":"**ALPHA**\n\n7-digit business postal code in `XXX-XXXX` format (separated by dash)"},"postalEntity":{"type":"string","enum":["Japan Post"],"description":"**ALPHA**\n\nThe postal entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.\n\nDescription of supported values:\n\n- **ALPHA** `Japan Post`: Field indicating the data source (fixed as `Japan Post` for Japan)"},"postalCodeType":{"type":"string","enum":["ZIP"],"description":"**ALPHA**\n\nThe postal code type.\n\nDescription of supported values:\n\n- **ALPHA** `ZIP`: Field describing the postal code type (fixed as `ZIP` for Japan)"},"businessName":{"type":"string","description":"**ALPHA**\n\nDetailed information specifies company name, building name, floor number, etc. mapped to the corresponding business postal code"}}},"PostalCodeDetails_Usps_Zip":{"type":"object","required":["postalCode"],"properties":{"postalCode":{"type":"string","description":"The postal code."},"postalEntity":{"type":"string","enum":["USPS"],"description":"The postal entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.\n\nDescription of supported values:\n\n- `USPS`: The USPS postal code system."},"postalCodeType":{"type":"string","enum":["ZIP"],"description":"The postal code type. Currently supported values: `ZIP` and `ZIP+4`\n\nDescription of supported values:\n\n- `ZIP`: A 5-digit code that identifies a specific geographic delivery area. ZIP codes can represent an area within a state, or a single building or company that has a very high mail volume."},"zipClassificationCode":{"type":"string","enum":["M","P","U"],"description":"The ZIP Classification Code.\n\nDescription of supported values:\n\n- `M`: Military ZIP code.\n- `P`: ZIP code having only Post Office boxes.\n- `U`: Unique ZIP code: A ZIP assigned to a company, agency, or entity with sufficient mail volume, based on average daily volume of letter-size pieces."}}},"PostalCodeDetails_Usps_ZipPlus4":{"type":"object","required":["postalCode"],"properties":{"postalCode":{"type":"string","description":"The postal code."},"postalEntity":{"type":"string","enum":["USPS"],"description":"The postal entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.\n\nDescription of supported values:\n\n- `USPS`: The USPS postal code system."},"postalCodeType":{"type":"string","enum":["ZIP+4"],"description":"The postal code type. Currently supported values: `ZIP` and `ZIP+4`\n\nDescription of supported values:\n\n- `ZIP+4`: Nine-digit code that identifies a small geographic delivery area that is serviceable by a single carrier; appears in the last line of the address on a mail piece."},"recordTypeCode":{"type":"string","enum":["F","G","H","P","R","S"],"description":"The USPS ZIP+4 Record Type Code.\n\nDescription of supported values:\n\n- `F`: Firm\n- `G`: General delivery\n- `H`: High-rise\n- `P`: PO Box\n- `R`: Rural route/contract\n- `S`: Street"}}},"DisplayResponseCoordinate":{"type":"object","required":["lat","lng"],"properties":{"lat":{"type":"number","format":"double","description":"Latitude of the address. For example: `\"52.19404\"`"},"lng":{"type":"number","format":"double","description":"Longitude of the address. For example: `\"8.80135\"`"}}},"BasicAccessPoint":{"type":"object","required":["lat","lng"],"properties":{"lat":{"type":"number","format":"double","description":"Latitude of the address. For example: `\"52.19404\"`"},"lng":{"type":"number","format":"double","description":"Longitude of the address. For example: `\"8.80135\"`"}}},"MapView":{"type":"object","required":["west","south","east","north"],"properties":{"west":{"type":"number","format":"double","description":"Longitude of the western-side of the box. For example: \"8.80068\""},"south":{"type":"number","format":"double","description":"Latitude of the southern-side of the box. For example: \"52.19333\""},"east":{"type":"number","format":"double","description":"Longitude of the eastern-side of the box. For example: \"8.8167\""},"north":{"type":"number","format":"double","description":"Latitude of the northern-side of the box. For example: \"52.19555\""}}},"Category":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifier number for an associated category. For example: `\"600-6600-0082\"`"},"name":{"type":"string","description":"Name of the place category in the result item language."},"primary":{"type":"boolean","description":"Whether or not it is a primary category. This field is visible only when the value is `true`."}}},"TimeZoneInfo":{"type":"object","required":["name","utcOffset"],"properties":{"name":{"type":"string","description":"The name of the time zone as defined in the [tz database](https://en.wikipedia.org/wiki/Tz_database). For example: \"Europe/Berlin\""},"utcOffset":{"type":"string","description":"The UTC offset for this time zone at request time. For example \"+02:00\""}}},"Scoring":{"type":"object","properties":{"queryScore":{"type":"number","format":"double","description":"Indicates how good the input matches the returned address. It is equal to 1 if all input tokens are recognized and matched."},"fieldScore":{"allOf":[{"$ref":"#/components/schemas/FieldScore"}],"description":"Indicates how good the individual result fields match to the corresponding part of the query. Is\nincluded only for the result fields that are actually matched to the query."}}},"Parsing":{"type":"object","properties":{"placeName":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MatchInfo"}]},"description":"Place name matches"},"country":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MatchInfo"}]},"description":"Country matches"},"state":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MatchInfo"}]},"description":"State matches"},"county":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MatchInfo"}]},"description":"County matches"},"city":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MatchInfo"}]},"description":"City matches"},"district":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MatchInfo"}]},"description":"District matches"},"subdistrict":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MatchInfo"}]},"description":"Subdistrict matches"},"street":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MatchInfo"}]},"description":"Street matches"},"block":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MatchInfo"}]},"description":"Block matches"},"subblock":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MatchInfo"}]},"description":"Subblock matches"},"houseNumber":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MatchInfo"}]},"description":"HouseNumber matches"},"postalCode":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MatchInfo"}]},"description":"PostalCode matches"},"building":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MatchInfo"}]},"description":"Building matches"},"secondaryUnits":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MatchInfo"}]},"description":"secondaryUnits matches"},"additionalInfo":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MatchInfo"}]},"description":"Additional information extracted from the query that do not correspond to any recognized address components in the map data."}}},"StreetInfo":{"type":"object","properties":{"baseName":{"type":"string","description":"Base name part of the street name."},"streetType":{"type":"string","description":"Street type part of the street name."},"streetTypePrecedes":{"type":"boolean","description":"Defines if the street type is before or after the base name."},"streetTypeAttached":{"type":"boolean","description":"Defines if the street type is attached or unattached to the base name."},"prefix":{"type":"string","description":"A prefix is a directional identifier that precedes, but is not included in, the base name of a road."},"suffix":{"type":"string","description":"A suffix is a directional identifier that follows, but is not included in, the base name of a road."},"direction":{"type":"string","description":"Indicates the official directional identifiers assigned to highways, typically either \"North/South\" or \"East/West\""},"language":{"type":"string","description":"BCP 47 compliant language code"}}},"CountryInfo":{"type":"object","properties":{"alpha2":{"type":"string","description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code"},"alpha3":{"type":"string","description":"[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code"}}},"TranslationsGeocode":{"type":"object","properties":{"stateNames":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/AdminNames"}]},"description":"The list of all state names and translations applicable to an address field, grouped by alternative views on it. For example, if subdivision of a country from administrative and postal views is different, some administrative levels may have two groups of names: from administrative and from postal views."},"countyNames":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/AdminNames"}]},"description":"The list of all county names and translations applicable to an address field, grouped by alternative views on it. For example, if subdivision of a country from administrative and postal views is different, some administrative levels may have two groups of names: from administrative and from postal views."},"cityNames":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/AdminNames"}]},"description":"The list of all city names and translations applicable to an address field, grouped by alternative views on it. For example, if subdivision of a country from administrative and postal views is different, some administrative levels may have two groups of names: from administrative and from postal views."},"districtNames":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/AdminNames"}]},"description":"The list of all district names and translations applicable to an address field, grouped by alternative views on it. For example, if subdivision of a country from administrative and postal views is different, some administrative levels may have two groups of names: from administrative and from postal views."}}},"MapReferenceSection":{"type":"object","properties":{"links":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/LinkInfoSection"}]},"description":"An identifier for link and the side of link the attribute is applicable to"},"pointAddress":{"allOf":[{"$ref":"#/components/schemas/PointAddressSection"}],"description":"The section containing the point address reference"},"microPointAddress":{"allOf":[{"$ref":"#/components/schemas/MicroPointAddressSection"}],"description":"**RESTRICTED**\n\nThe section containing the micro point address reference. This type of reference is only returned by Lookup endpoint or Geocode endpoint when showMapReference='microPointAddress' parameter is provided."},"segments":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Segment"}]},"description":"The section containing the segment references"},"country":{"allOf":[{"$ref":"#/components/schemas/AdminIdSection"}],"description":"country ID in HERE Map Content"},"state":{"allOf":[{"$ref":"#/components/schemas/AdminIdSection"}],"description":"state ID in HERE Map Content"},"county":{"allOf":[{"$ref":"#/components/schemas/AdminIdSection"}],"description":"county ID in HERE Map Content"},"city":{"allOf":[{"$ref":"#/components/schemas/AdminIdSection"}],"description":"city ID in HERE Map Content"},"district":{"allOf":[{"$ref":"#/components/schemas/AdminIdSection"}],"description":"district ID in HERE Map Content"},"subdistrict":{"allOf":[{"$ref":"#/components/schemas/AdminIdSection"}],"description":"subdistrict ID in HERE Map Content"},"cmVersion":{"allOf":[{"$ref":"#/components/schemas/CmVersionSection"}],"description":"cmVerison info in HERE Map Content"}}},"RelatedAddress":{"type":"object","required":["relationship","id"],"properties":{"relationship":{"type":"string","enum":["MPA","intersection","nearbyAddress","parentPA"],"description":"\n\nDescription of supported values:\n\n- **RESTRICTED** `MPA`: Micro Point Addresses related to a result items with\n  `resultType` = `houseNumber` and `houseNumberType` = `PA`;\n  for example, buildings, floors (levels) or suites (units)\n  associated to this address. This type of relationship is\n  only returned by the Lookup endpoint and the Geocode endpoint\n  when the `showRelated=MPA` parameter is provided.\n- `intersection`: The Intersections nearest to the address. This type of relationship is\n  only returned by Reverse Geocode, Geocode or Multi-Reverse Geocode\n  endpoints when `showRelated=intersections` parameter is provided.\n- `nearbyAddress`: Nearby address on the same street of main result. This type of\n  relationship is only returned by Reverse Geocode endpoint or\n  Multi-Reverse Geocode endpoint when `showRelated=nearbyAddress`\n  parameter is provided.\n- **RESTRICTED** `parentPA`: The Point Address to which the Micro Point Address\n  belongs; for example the house number to which this\n  suite is associated. This type of relationship is only\n  returned by the Lookup, the Geocode and the (Multi) Reverse Geocode endpoints when\n  the `showRelated=parentPA` parameter is provided."},"title":{"type":"string","description":"The localized display name of this related entity."},"id":{"type":"string","description":"The ID of the related entity."},"resultType":{"type":"string","enum":["addressBlock","administrativeArea","houseNumber","intersection","locality","place","postalCodePoint","street"],"description":"The resultType of the related entity."},"houseNumberType":{"type":"string","enum":["MPA","PA","interpolated"],"description":"The houseNumberType of the related entity.\n\nDescription of supported values:\n\n- **RESTRICTED** `MPA`: A Micro Point Address represents a secondary address for a Point\n  Address; for example, building, floor (level) and suite (unit).\n  Micro Point Addresses can be used to enhance Point Address with\n  greater address detail and higher coordinate accuracy. This result\n  type is only returned by Lookup, Geocode, Autocomplete or (Multi) Reverse Geocode endpoints when\n  `with=MPA` parameter is provided.\n- `PA`: A Point Address represents an individual address as a point object.\n  Point Addresses are coming from trusted sources. There is a\n  high certainty that the address exists at that position. A\n  Point Address result contains two types of coordinates. One is the\n  access point (or navigation coordinates), which is the point to\n  start or end a drive. The other point is the position or display\n  point. This point varies per source and country. The point can be\n  the rooftop point, a point close to the building entry, or a point\n  close to the building, driveway or parking lot that belongs to the\n  building.\n- `interpolated`: An interpolated address. These are approximate positions as a\n  result of a linear interpolation based on address ranges. Address\n  ranges, especially in the USA, are typical per block. For\n  interpolated addresses, we cannot say with confidence that the\n  address exists in reality. But the interpolation provides a good\n  location approximation that brings people in most use cases close\n  to the target location. The access point of an interpolated address\n  result is calculated based on the address range and the road\n  geometry. The position (display) point is pre-configured offset\n  from the street geometry. Compared to Point Addresses, interpolated\n  addresses are less accurate."},"address":{"allOf":[{"$ref":"#/components/schemas/RelatedResultAddress"}],"description":"The address of the related entity. The fields are only rendered, if they differ from the main result item."},"position":{"allOf":[{"$ref":"#/components/schemas/DisplayResponseCoordinate"}],"description":"The coordinates (latitude, longitude) of a pin on a map corresponding to the searched place."},"access":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/BasicAccessPoint"}]},"description":"Coordinates of the response item on a HERE map navigable link (for example, for driving or walking)."},"distance":{"type":"integer","format":"int64","description":"The distance \"as the crow flies\" from the search center to this related address' position in meters.\nIt is only returned by Reverse Geocode endpoint or Multi-Reverse Geocode endpoint."},"routeDistance":{"type":"integer","format":"int64","description":"The distance from routing position of the nearby address to the street result, the distance is\ncalculated based on the underlying road geometry. It is only returned by Reverse Geocode endpoint or\nMulti-Reverse Geocode endpoint."},"bearing":{"type":"integer","format":"int32","description":"Bearing (measured clockwise from true north) from the projected coordinate on the street to the\ndisplay position of the related location. True clockwise degree, 0 is north. It is only returned by\nReverse Geocode endpoint or Multi-Reverse Geocode endpoint."},"mapView":{"allOf":[{"$ref":"#/components/schemas/MapView"}],"description":"The bounding box enclosing the geometric shape (area or line) that the related address covers. It is\n only returned by Reverse Geocode endpoint or Multi-Reverse Geocode endpoint."},"mapReferences":{"allOf":[{"$ref":"#/components/schemas/MapReferenceSection"}],"description":"Return the map references of the location objects. It is only returned by Reverse Geocode endpoint\nor Multi-Reverse Geocode endpoint."}}},"NavigationAttributes":{"type":"object","properties":{"speedLimits":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/SpeedLimit"}]},"description":"Speed limit for the navigable road following the direction of traffic on the street. If traffic is allowed in both directions\ntwo value sets will be returned. If the request contained a bearing parameter, then the first entry will match the returned\ndirection."},"functionalClass":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/FunctionalClass"}]},"description":"The value represents one of the five levels:"},"access":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Access"}]},"description":"The following boolean values are available for access attributes:"},"physical":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Physical"}]},"description":"The following boolean values are available for physical attributes:"}}},"SecondaryUnitInfo":{"type":"object","required":["normalizedUnitType","unitValue"],"properties":{"normalizedUnitType":{"type":"string","description":"The secondary unit designator is provided in a normalized, country-specific format. If the secondary unit designator is omitted or unrecognized, it is returned as \"unknown\"."},"unitValue":{"type":"string","description":"The unit value in normalized form. It may be empty when secondary unit designator has no unit value, for example \"Basement\"."}}},"FieldScore":{"type":"object","properties":{"country":{"type":"number","format":"double","description":"Indicates how good the result country name or [ISO 3166-1 alpha-3] country code matches to the freeform or qualified input."},"countryCode":{"type":"number","format":"double","description":"Indicates how good the result [ISO 3166-1 alpha-3] country code matches to the freeform or qualified input."},"state":{"type":"number","format":"double","description":"Indicates how good the result state name matches to the freeform or qualified input."},"stateCode":{"type":"number","format":"double","description":"Indicates how good the result state code matches to the freeform or qualified input."},"county":{"type":"number","format":"double","description":"Indicates how good the result county name matches to the freeform or qualified input."},"countyCode":{"type":"number","format":"double","description":"Indicates how good the result county code matches to the freeform or qualified input."},"city":{"type":"number","format":"double","description":"Indicates how good the result city name matches to the freeform or qualified input."},"district":{"type":"number","format":"double","description":"Indicates how good the result district name matches to the freeform or qualified input."},"subdistrict":{"type":"number","format":"double","description":"Indicates how good the result sub-district name matches to the freeform or qualified input."},"streets":{"type":"array","items":{"type":"number","format":"double"},"description":"Indicates how good the result street names match to the freeform or qualified input. If the input\ncontains multiple street names, the field score is calculated and returned for each of them\nindividually."},"block":{"type":"number","format":"double","description":"Indicates how good the result block name matches to the freeform or qualified input."},"subblock":{"type":"number","format":"double","description":"Indicates how good the result sub-block name matches to the freeform or qualified input."},"houseNumber":{"type":"number","format":"double","description":"Indicates how good the result house number matches to the freeform or qualified input. It may\nhappen, that the house number, which one is looking for, is not yet in the map data. For such cases,\nthe Geocode endpoint returns the nearest known house number on the same street. This represents the\nnumeric difference between the requested and the returned house numbers."},"postalCode":{"type":"number","format":"double","description":"Indicates how good the result postal code matches to the freeform or qualified input."},"building":{"type":"number","format":"double","description":"Indicates how good the result building name matches to the freeform or qualified input."},"unit":{"type":"number","format":"double","description":"Indicates whether a secondary unit (such as building, floor or suite) has been recognized in the freeform or qualified input."},"placeName":{"type":"number","format":"double","description":"Indicates how good the result place name matches to the freeform or qualified input."},"ontologyName":{"type":"number","format":"double","description":"Indicates how good the result ontology name matches to the freeform or qualified input."}}},"MatchInfo":{"type":"object","required":["start","end","value"],"properties":{"start":{"type":"integer","format":"int32","description":"First index of the matched range (0-based indexing, inclusive)"},"end":{"type":"integer","format":"int32","description":"One past the last index of the matched range (0-based indexing, exclusive); The difference between end and start gives the length of the term"},"value":{"type":"string","description":"Matched term in the input string"},"qq":{"type":"string","enum":["city","country","county","district","houseNumber","postalCode","state","street"],"description":"The matched qualified query field type. If this is not returned, then matched value refers to the freetext query"}}},"AdminNames":{"type":"object","required":["names"],"properties":{"names":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Name"}]},"description":"The list of all values for a name. Those might be for different languages or different name types."},"preference":{"type":"string","enum":["alternative","primary"],"description":"The preference of the view on an address field expressed by this group of names.\n\nDescription of supported values:\n\n- `alternative`: Alternative view on this address field. Names of this group are exposed in the result only if matching to the query so that the end-user can better recognize the result.\n- `primary`: The default or only view on this address filed. These are the names which are exposed in the result by default."}}},"LinkInfoSection":{"type":"object","required":["cmId","side"],"properties":{"cmId":{"type":"string","description":"link ID in HERE core map"},"side":{"type":"string","description":"The side of the link the attribute is applicable to\n\n- for `resultType=houseNumber` and `resultType=place`: side of the entity to the link\n- for `resultType=street`:\n  - on endpoints *Geocode* and *Lookup*: side of the entity to the link, it is always \"both\"\n  - on endpoints *Reverse Geocode* and *Multi-Reverse Geocode*: relative side from input to the link\n"}}},"PointAddressSection":{"type":"object","required":["hmcId"],"properties":{"hmcId":{"type":"string","description":"The point address ID in HERE Map Content"},"partitionId":{"type":"string","description":"**ALPHA**\n\nUnique identifier that references a specific subset of geo-location related layers\n(e.g., address, location, street, or place) in the HERE Map Content"}}},"MicroPointAddressSection":{"type":"object","required":["hmcId"],"properties":{"hmcId":{"type":"string","description":"The micro point address ID in HERE Map Content"},"partitionId":{"type":"string","description":"**ALPHA**\n\nUnique identifier that references a specific subset of geo-location related layers\n(e.g., address, location, street, or place) in the HERE Map Content"}}},"Segment":{"type":"object","properties":{"ref":{"type":"string","description":"The segment reference follows the format `{segmentId}(#{offset})?`,\nrepresenting its relative position from the result location to a segment."},"side":{"type":"string","description":"The side of the link the attribute is applicable to\n\n- for `resultType=houseNumber` and `resultType=place`: side of the entity to the link\n- for `resultType=street`:\n  - on endpoints *Geocode* and *Lookup*: side of the entity to the link, it is always \"both\"\n  - on endpoints *Reverse Geocode* and *Multi-Reverse Geocode*: relative side from input to the link\n"}}},"AdminIdSection":{"type":"object","required":["hmcId"],"properties":{"hmcId":{"type":"string","description":"Admin ID in HERE Map Content"},"partitionId":{"type":"string","description":"**ALPHA**\n\nUnique identifier that references a specific subset of geo-location related layers\n(e.g., address, location, street, or place) in the HERE Map Content"}}},"CmVersionSection":{"type":"object","required":["region","dvn"],"properties":{"region":{"type":"string","description":"Region ID"},"dvn":{"type":"string","description":"Map version details (DVN) containing the base line for the map schema and an identifier for the weekly or quarterly update.\n\n- Format: YYQ<weekly/quaterly update>\n  - Example: 23150 (map schema: Q1/2023, weekly update 50)\n"}}},"RelatedResultAddress":{"type":"object","properties":{"label":{"type":"string","description":"Assembled address value built out of the address components according to the regional postal rules.\nThese are the same rules for all endpoints. It may not include all the input terms."},"countryCode":{"type":"string","description":"A three-letter country code. For example: \"DEU\""},"countryName":{"type":"string","description":"The localised country name. For example: \"Deutschland\""},"stateCode":{"type":"string","description":"A state code or state name abbreviation – country specific. For example, in the United States it is the two letter state abbreviation: \"CA\" for California."},"state":{"type":"string","description":"The state division of a country. For example: \"North Rhine-Westphalia\""},"countyCode":{"type":"string","description":"A county code or county name abbreviation – country specific. For example, for Italy it is the province abbreviation: \"RM\" for Rome."},"county":{"type":"string","description":"A division of a state; typically, a secondary-level administrative division of a country or equivalent."},"city":{"type":"string","description":"The name of the primary locality of the place. For example: \"Bad Oyenhausen\""},"district":{"type":"string","description":"A division of city; typically an administrative unit within a larger city or a customary name of a city's neighborhood. For example: \"Bad Oyenhausen\""},"subdistrict":{"type":"string","description":"A subdivision of a district. For example: \"Minden-Lübbecke\""},"street":{"type":"string","description":"Name of street. For example: \"Schulstrasse\""},"streets":{"type":"array","items":{"type":"string"},"description":"Names of streets in case of intersection result. For example: [\"Friedrichstraße\",\"Unter den Linden\"]"},"block":{"type":"string","description":"Name of block."},"subblock":{"type":"string","description":"Name of sub-block."},"postalCode":{"type":"string","description":"An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code. For example: \"32547\""},"houseNumber":{"type":"string","description":"House number. For example: \"4\""},"building":{"type":"string","description":"Name of building."},"unit":{"type":"string","description":"defining a Micro Point Address. Combines unit name (suite, flat, etc.), level name (floor) and\nbuilding unit name for a Micro Point Address"}}},"SpeedLimit":{"type":"object","required":["maxSpeed","speedUnit"],"properties":{"maxSpeed":{"type":"integer","format":"int32","description":"Used in combination with speed limit unit to indicate allowable speed limit at a location, for unlimited speed, the value is \"999\""},"direction":{"type":"string","enum":["E","N","NE","NW","S","SE","SW","W"],"description":"Rendered in compass value, which is N, S, E, W, NE, SE, NW, SW"},"speedUnit":{"type":"string","enum":["kph","mph"],"description":"Country defined speed unit"},"source":{"type":"string","enum":["derived","posted"],"description":"A generalised identification of the source of `Speed Limit` information.\n\nDescription of supported values:\n\n- `derived`: Based on administrative regulations, for example: highway exit/entry ramps that do not have posted speed limits.\n- `posted`: Based on a posted speed limit sign, speed limit information painted on the road, or data obtained from official sources."}}},"FunctionalClass":{"type":"object","required":["value"],"properties":{"value":{"type":"string","enum":["1","2","3","4","5"],"description":"\n\nDescription of supported values:\n\n- `1`: allowing for high volume, maximum speed traffic movement\n- `2`: allowing for high volume, high speed traffic movement\n- `3`: providing a high volume of traffic movement\n- `4`: providing for a high volume of traffic movement at moderate speeds between neighbourhoods\n- `5`: roads whose volume and traffic movement are below the level of any functional class"}}},"Access":{"type":"object","properties":{"automobiles":{"type":"boolean","description":"Applicable to automobiles.\n\n- `true`: The road allows automobiles.\n- `false`: The road doesn't allow automobiles.\n"},"bicycles":{"type":"boolean","description":"Applicable to bicycles.\n\n- `true`: The road allows bicycles.\n- `false`: The road doesn't allow bicycles.\n"},"buses":{"type":"boolean","description":"Applicable to buses.\n\n- `true`: The road allows buses.\n- `false`: The road doesn't allow buses.\n"},"carpools":{"type":"boolean","description":"Applicable to carpools.\n\n- `true`: The road allows carpooling.\n- `false`: The road doesn't allow carpooling.\n"},"deliveries":{"type":"boolean","description":"Applicable to deliveries.\n\n- `true`: The road allows deliveries.\n- `false`: The road doesn't allow deliveries.\n"},"emergencyVehicles":{"type":"boolean","description":"Applicable to emergency vehicles.\n\n- `true`: The road allows emergency vehicles.\n- `false`: The road doesn't allow emergency vehicles.\n"},"motorcycles":{"type":"boolean","description":"Applicable to motorcycles.\n\n- `true`: The road allows motorcycles.\n- `false`: The road doesn't allow motorcycles.\n"},"pedestrians":{"type":"boolean","description":"Applicable to pedestrians.\n\n- `true`: The road allows pedestrians.\n- `false`: The road doesn't allow pedestrians.\n"},"taxis":{"type":"boolean","description":"Applicable to taxis.\n\n- `true`: The road allows taxis.\n- `false`: The road doesn't allow taxis.\n"},"throughTraffic":{"type":"boolean","description":"Applicable to through traffic.\n\n- `true`: The road allows through traffic.\n- `false`: The road doesn't allow through traffic.\n"},"trucks":{"type":"boolean","description":"Applicable to trucks.\n\n- `true`: The road allows trucks.\n- `false`: The road doesn't allow trucks.\n"}}},"Physical":{"type":"object","properties":{"boatFerry":{"type":"boolean","description":"The segment represents a generalised route of a boat ferry for passengers or vehicles over water,\nincluding routes to pedestrian only islands, tourist areas, commuter ferry routes open to only pedestrians, etc.\n\n- `true`: The road is a boat ferry.\n- `false`: The road isn't a boat ferry."},"bridge":{"type":"boolean","description":"Identifies a structure that allows a road, railway, or walkway to pass over another road,\nrailway, waterway, or valley serving map display and route guidance functionalities.\n\n- `true`: The road is a bridge.\n- `false`: The road isn't a bridge."},"deliveryRoad":{"type":"boolean","description":"Indication of a delivery road.\n\n- `true`: The physical characteristic of the road is that it functions as a delivery road.\n- `false`: The physical characteristic of the road is that it doesn't function as a delivery road."},"movableBridge":{"type":"boolean","description":"Movable Bridge indicates a bridge that moves to allow passage (usually) for boats or barges.\n\n- `true`: The road is a movable bridge.\n- `false`: The road isn't a movable bridge.\n"},"multiplyDigitized":{"type":"boolean","description":"Multiply Digitised identifies separately digitised roads, i.e., roads that are digitised with one line per\ndirection of traffic instead of one line per road.\n\n- `true`: The physical characteristic of the road is that it functions as multiplyDigitized.\n- `false`: The physical characteristic of the road is that it doesn't function as multiplyDigitized."},"paved":{"type":"boolean","description":"Indicates whether the navigable segment is paved.\n\n- `true`: The physical characteristic of the road is paved.\n- `false`: The physical characteristic of the road isn't paved."},"private":{"type":"boolean","description":"Private identifies roads that are not maintained by an organisation responsible for maintenance of\npublic roads.\n\n- `true`: The road is private..\n- `false`: The road isn't private."},"railFerry":{"type":"boolean","description":"The segment represents a generalised route of a ferry for passengers or vehicles via rail.\n\n- `true`: The road is a rail flerry.\n- `false`: The road isn't a rail flerry.\n"},"tunnel":{"type":"boolean","description":"Identifies an enclosed (on all sides) passageway through or under an obstruction.\n\n- `true`: The road is a tunnel.\n- `false`: The road isn't a tunnel.\n"}}},"Name":{"type":"object","required":["value","type"],"properties":{"value":{"type":"string","description":"The text value of this name."},"language":{"type":"string","description":"The [BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) language code."},"type":{"type":"string","enum":["abbreviation","areaCode","baseName","exonym","shortened","synonym"],"description":"The type of this name.\n\nDescription of supported values:\n\n- `abbreviation`: Abbreviation is a shortened form of the official name.  For example, \"CA\" for \"California\". Abbreviation may also be an area code.\n- `areaCode`: Area code is a code representation of an admin. For example for countries this can be an ISO-3 or ISO-2 Code: \"USA\", \"US\" for \"United States\".\n- `baseName`: Base name represents the official name in one of the country official languages. For example, \"Frankfurt am Main\".\n- `exonym`: Exonym is a translation of the official name to a language that is not one of the country official languages. For example \"Francfort-sur-le-Main\" for \"Frankfurt am Main\".\n- `shortened`: A shortened variant of a long name where optional parts are omitted. For example, \"Bad Soden\" for \"Bad Soden am Taunus\".\n- `synonym`: A synonym is an additional commonly used name that is different than the official name, in the same language as the official name. For example, \"Frankfurt\" for \"Frankfurt am Main\"."},"primary":{"type":"boolean","description":"Flag indicating whether it is a primary name. This is the name which is exposed in the result by default. This field is visible only when the value is `true`."},"transliterated":{"type":"boolean","description":"Flag indicating whether the name is transliterated. Additional transliterated form of the name is included for all non-Latin-1 names. This field is visible only when the value is `true`."}}}},"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"}}}}