openapi: 3.2.0 info: title: Geocoding and Search API v7 Revgeocode API version: '7.155' description: This document describes the Geocoding and Search API. security: - Bearer: [] - ApiKey: [] tags: - name: Revgeocode paths: /revgeocode: servers: - url: https://revgeocode.search.hereapi.com/v1 get: summary: Reverse Geocode description: This endpoint returns the nearest address to geo coordinates specified in the request. parameters: - $ref: '#/components/parameters/addressNamesVariantLookupRevgeocode' - $ref: '#/components/parameters/atRevgeocode' - $ref: '#/components/parameters/bearing' - $ref: '#/components/parameters/inRevgeocode' - $ref: '#/components/parameters/typesRevgeocode' - $ref: '#/components/parameters/withRevgeocode' - $ref: '#/components/parameters/langAutosuggestBrowseDiscoverGeocodeLookupRevgeocode' - $ref: '#/components/parameters/limitRevgeocode' - $ref: '#/components/parameters/politicalView' - $ref: '#/components/parameters/showMapReferencesGeocodeLookupRevgeocode' - $ref: '#/components/parameters/showNavAttributes' - $ref: '#/components/parameters/showRelatedRevgeocode' - $ref: '#/components/parameters/showRevgeocode' - $ref: '#/components/parameters/X-Request-ID' responses: '200': description: The search results. content: application/json: schema: $ref: '#/components/schemas/OpenSearchReverseGeocodeResponse' '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' tags: - Revgeocode operationId: getRevgeocode x-operation-id-source: derived components: schemas: Segment: type: object properties: ref: type: string description: 'The segment reference follows the format `{segmentId}(#{offset})?`, representing 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" OpenSearchReverseGeocodeResponse: type: object required: - items properties: items: type: array items: allOf: - $ref: '#/components/schemas/ReverseGeocodeResultItem' 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. PointAddressSection: type: object required: - hmcId properties: hmcId: type: string description: The point address ID in HERE Map Content partitionId: type: string description: '**ALPHA** Unique identifier that references a specific subset of geo-location related layers (e.g., address, location, street, or place) in the HERE Map Content' 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.) 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 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 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** The 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 FunctionalClass: type: object required: - value properties: value: type: string enum: - '1' - '2' - '3' - '4' - '5' description: ' Description of supported values: - `1`: allowing for high volume, maximum speed traffic movement - `2`: allowing for high volume, high speed traffic movement - `3`: providing a high volume of traffic movement - `4`: providing for a high volume of traffic movement at moderate speeds between neighbourhoods - `5`: roads whose volume and traffic movement are below the level of any functional class' ReverseGeocodeResultItem: 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 - locality - place - postalCodePoint - street description: ' Type of the result item. Note: `addressBlock` result item is either a block or subblock. `resultType` values can get added to the list without further notice. ' 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: ' Type of the address block result if the `resultType` field is set to `addressBlock`. `addressBlockType` values can get added to the list without further notice. ' localityType: type: string enum: - city - district - postalCode - subdistrict description: ' Type of the locality result if the `resultType` field is set to `locality`. `localityType` values can get added to the list without further notice. ' administrativeAreaType: type: string enum: - country - county - state description: ' Type of the administrative area result if the `resultType` field is set to `administrativeArea`. `administrativeAreaType` values can get added to the list without further notice. ' address: allOf: - $ref: '#/components/schemas/RgcAddress' description: Postal address of the result item. postalCodeDetails: type: array items: oneOf: - $ref: '#/components/schemas/PostalCodeDetails_Usps_Zip' - $ref: '#/components/schemas/PostalCodeDetails_Usps_ZipPlus4' description: 'Additional information for `postalCodePoint` results (only rendered if `show=postalCodeDetails` is provided 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. For 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 estimated. This field is visible only for result items with resultType `houseNumber` and houseNumberType `PA` and only 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.) 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.) estimatedAreaFallback: type: boolean description: '**ALPHA** Indicates that the admin result is not retrieved from a carto shape but from the closest street. (Only rendered, if `with=estimatedAreaFallback` is provided.)' 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 is specified with valid value and relevant data is available. The value is a comma-separated list of the sections to be enabled.' 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. Description of supported values: - `USPS`: The USPS postal code system.' postalCodeType: type: string enum: - ZIP+4 description: 'The postal code type. Currently supported values: `ZIP` and `ZIP+4` Description of supported values: - `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. Description of supported values: - `F`: Firm - `G`: General delivery - `H`: High-rise - `P`: PO Box - `R`: Rural route/contract - `S`: Street' 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\n - Example: 23150 (map schema: Q1/2023, weekly update 50)\n" 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. Description of supported values: - `derived`: Based on administrative regulations, for example: highway exit/entry ramps that do not have posted speed limits. - `posted`: Based on a posted speed limit sign, speed limit information painted on the road, or data obtained from official sources.' 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' 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"`' RgcAddress: type: object properties: label: type: string description: 'Assembled address value built out of the address components according to the regional postal rules. These are the same rules for all endpoints. It may not include all the input terms. For example: "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"' 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. Physical: type: object properties: boatFerry: type: boolean description: 'The segment represents a generalised route of a boat ferry for passengers or vehicles over water, including routes to pedestrian only islands, tourist areas, commuter ferry routes open to only pedestrians, etc. - `true`: The road is a boat ferry. - `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, railway, waterway, or valley serving map display and route guidance functionalities. - `true`: The road is a bridge. - `false`: The road isn''t a bridge.' deliveryRoad: type: boolean description: 'Indication of a delivery road. - `true`: The physical characteristic of the road is that it functions as a delivery road. - `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. - `true`: The road is a movable bridge. - `false`: The road isn''t a movable bridge. ' multiplyDigitized: type: boolean description: 'Multiply Digitised identifies separately digitised roads, i.e., roads that are digitised with one line per direction of traffic instead of one line per road. - `true`: The physical characteristic of the road is that it functions as multiplyDigitized. - `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. - `true`: The physical characteristic of the road is paved. - `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 public roads. - `true`: The road is private.. - `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. - `true`: The road is a rail flerry. - `false`: The road isn''t a rail flerry. ' tunnel: type: boolean description: 'Identifies an enclosed (on all sides) passageway through or under an obstruction. - `true`: The road is a tunnel. - `false`: The road isn''t a tunnel. ' 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. It 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 calculated based on the underlying road geometry. It is only returned by Reverse Geocode endpoint or Multi-Reverse Geocode endpoint.' bearing: type: integer format: int32 description: 'Bearing (measured clockwise from true north) from the projected coordinate on the street to the display position of the related location. True clockwise degree, 0 is north. It is only returned by Reverse 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 or Multi-Reverse Geocode endpoint.' 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. Description of supported values: - `USPS`: The USPS postal code system.' postalCodeType: type: string enum: - ZIP description: 'The postal code type. Currently supported values: `ZIP` and `ZIP+4` Description of supported values: - `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. Description of supported values: - `M`: Military ZIP code. - `P`: ZIP code having only Post Office boxes. - `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.' 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"`' 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" Access: type: object properties: automobiles: type: boolean description: 'Applicable to automobiles. - `true`: The road allows automobiles. - `false`: The road doesn''t allow automobiles. ' bicycles: type: boolean description: 'Applicable to bicycles. - `true`: The road allows bicycles. - `false`: The road doesn''t allow bicycles. ' buses: type: boolean description: 'Applicable to buses. - `true`: The road allows buses. - `false`: The road doesn''t allow buses. ' carpools: type: boolean description: 'Applicable to carpools. - `true`: The road allows carpooling. - `false`: The road doesn''t allow carpooling. ' deliveries: type: boolean description: 'Applicable to deliveries. - `true`: The road allows deliveries. - `false`: The road doesn''t allow deliveries. ' emergencyVehicles: type: boolean description: 'Applicable to emergency vehicles. - `true`: The road allows emergency vehicles. - `false`: The road doesn''t allow emergency vehicles. ' motorcycles: type: boolean description: 'Applicable to motorcycles. - `true`: The road allows motorcycles. - `false`: The road doesn''t allow motorcycles. ' pedestrians: type: boolean description: 'Applicable to pedestrians. - `true`: The road allows pedestrians. - `false`: The road doesn''t allow pedestrians. ' taxis: type: boolean description: 'Applicable to taxis. - `true`: The road allows taxis. - `false`: The road doesn''t allow taxis. ' throughTraffic: type: boolean description: 'Applicable to through traffic. - `true`: The road allows through traffic. - `false`: The road doesn''t allow through traffic. ' trucks: type: boolean description: 'Applicable to trucks. - `true`: The road allows trucks. - `false`: The road doesn''t allow trucks. ' 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`. AdminIdSection: type: object required: - hmcId properties: hmcId: type: string description: Admin ID in HERE Map Content partitionId: type: string description: '**ALPHA** Unique identifier that references a specific subset of geo-location related layers (e.g., address, location, street, or place) in the HERE Map Content' RelatedResultAddress: type: object properties: label: type: string description: 'Assembled address value built out of the address components according to the regional postal rules. These 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 building unit name for a Micro Point Address' 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 two value sets will be returned. If the request contained a bearing parameter, then the first entry will match the returned direction.' 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:' MicroPointAddressSection: type: object required: - hmcId properties: hmcId: type: string description: The micro point address ID in HERE Map Content partitionId: type: string description: '**ALPHA** Unique identifier that references a specific subset of geo-location related layers (e.g., address, location, street, or place) in the HERE Map Content' 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"' 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" parameters: withRevgeocode: 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, CAN, NZL, USA (with the territory of PRI).\n- `unnamedStreets`: Enables the retrieval of unnamed street results.\n- **ALPHA** `estimatedAreaFallback`: Adds district and city names to results in areas where the respective names cannot be obtained from area polygon data.\n Instead, the Reverse Geocoder estimates these names based on administrative assignments to streets.\n A flag “`estimatedAreaFallback: true`” is returned in response which indicates the administrative result is estimated.\n 'Distance' is calculated from the input to the closest street section, user could judge the result confidence from the distance.\n While this estimation can be helpful in many cases, it may not always be completely accurate.\n The probability of false results, such as neighboring district or city names, exists primarily in border regions.\n This means that when streets are near the border between different administrative districts or cities,\n the estimation may occasionally provide the wrong district or city name." in: query explode: false required: false schema: type: array items: type: string enum: - MPA - estimatedAreaFallback - unnamedStreets 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 limitRevgeocode: name: limit description: Maximum number of results to be returned. in: query required: false schema: type: integer format: int32 minimum: 1 maximum: 100 default: 1 bearing: name: bearing description: 'Takes the "bearing" into account for matching nearby street results. Bearing expresses the direction in which an asset is heading in degrees starting at true north and continuing clockwise around the compass. North is 0 degrees, east is 90 degrees, south is 180 degrees, and west is 270 degrees. Values are expected to be of type Integer. When this parameter is provided, all results will be of type `street`. It is not necessary to provide `types=street` explicitly. The following constraints apply: * If a `types` parameter is provided, the only accepted value is `types=street`. ' in: query required: false schema: type: integer format: int32 minimum: 0 maximum: 359 example: 42 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 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 politicalView: name: politicalView description: 'Toggle the political view. This parameter accepts a single ISO 3166-1 alpha-3 country code in all uppercase. If 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. The following political views are currently supported: - `ARG`: Argentina''s view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands - `EGY`: Egypt''s view on Bir Tawil - `IND`: India''s view on Gilgit-Baltistan - `KEN`: Kenya''s view on the Ilemi Triangle - `MAR`: Morocco''s view on Western Sahara - `PAK`: Pakistan''s view on Jammu and Kashmir and the Junagadh Area - `RUS`: Russia''s view on Crimea - `SDN`: Sudan''s view on the Halaib Triangle - `SRB`: Serbia''s view on Kosovo, Vukovar, and Sarengrad Islands - `SUR`: Suriname''s view on the Courantyne Headwaters and Lawa Headwaters - `SYR`: Syria''s view on the Golan Heights - `TUR`: Turkey''s view on Cyprus and Northern Cyprus - `TZA`: Tanzania''s view on Lake Malawi - `URY`: Uruguay''s view on Rincon de Artigas - `VNM`: Vietnam''s view on the Paracel Islands and Spratly Islands' in: query required: false schema: type: string 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: `addressNamesVariant[city]=administrative` Description of supported values: - `administrative`: Returns the administrative name for the selected component in the address result. This option is currently supported **only in the USA**.' 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 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 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. Format: Free string, but a valid UUIDv4 is recommended.' in: header required: false schema: type: string showRelatedRevgeocode: name: showRelated description: 'allows enriching some types of response items with related items Description of supported values: - `intersections`: For street and house number results, include a block containing a list of intersections nearest to the address. - `nearbyAddress`: Add nearby address as additional reference to the street level results in Reverse Geocode or Multi-Reverse Geocode, the feature is only available with parameter `bearing` or `types=street`. - **RESTRICTED** `parentPA`: For `type=houseNumber` and `houseNumberType=MPA` result items, include a block containing the "parent" point addresses associated with this micro point address. GS7 supports micro point addresses in the following countries: AUS, AUT, CAN, NZL, USA (with the territory of PRI).' in: query explode: false required: false schema: type: array items: type: string enum: - intersections - nearbyAddress - parentPA showRevgeocode: 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- `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- `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 - postalCodeDetails - streetInfo - tz 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 securitySchemes: Bearer: description: 'A token obtained from a separate endpoint using client credentials and an OAuth 1.0a HMAC-SHA256 signed request. For more information on how to get a bearer token, see the [Identity and Access Management Developer Guide](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/). ' type: http scheme: bearer bearerFormat: JWT ApiKey: description: 'A key generated specifically to authenticate API requests. For more information on how to get an API key, see the [Identity and Access Management Developer Guide](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/). ' type: apiKey name: apiKey in: query externalDocs: description: The developer guide, release notes, and migration guide are available here. url: https://www.here.com/docs/category/geocoding-search-v7