ap-southeast-1 and ap-southeast-5 regions support only up to a maximum value of 100,000.
- `MaxResults` integer — An optional limit for the number of results returned in a single call.
Default value: 1
- `Filter` object — The included place types. - `IncludePlaceTypes` ReverseGeocodeFilterPlaceType[] — The included place types. For GrabMaps customers,ap-southeast-1 and ap-southeast-5 regions support only Street and PointAddress values.
- `AdditionalFeatures` ReverseGeocodeAdditionalFeature[] — A list of optional additional parameters, such as time zone that can be requested for each result. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the TimeZone value.
- `Language` string — A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the following codes: en, id, km, lo, ms, my, pt, th, tl, vi, zh
- `PoliticalView` string, password — The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
- `IntendedUse` 'SingleUse' | 'Storage' — Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored).
When storing ReverseGeocode responses, you must set this field to Storage to comply with the terms of service. These requests will be charged at a higher rate. Please review the user agreement and service pricing structure to determine the correct setting for your use case.
The heading in degrees from true north in a navigation context. The heading is measured as the angle clockwise from the North direction.
Example: North is 0 degrees, East is 90 degrees, South is 180 degrees, and West is 270 degrees.
Administrative, the service returns the official administrative names for address components. Administrative currently applies only to addresses in the United States.
## Response `200`
Success
- ReverseGeocodeResponse
- `ResultItems` ReverseGeocodeResultItem[] — List of places or results returned for a query.
- `PlaceId` string, password, required — The PlaceId of the place you wish to receive the information for.
- `PlaceType` 'Country' | 'Region' | 'SubRegion' | 'Locality' | 'District' | 'SubDistrict' | 'PostalCode' | 'Block' | 'SubBlock' | 'Intersection' | 'Street' | 'PointOfInterest' | 'PointAddress' | 'InterpolatedAddress' | 'SecondaryAddress' | 'InferredSecondaryAddress', password, required — A PlaceType is a category that the result place must belong to.
- `Title` string, password, required — The localized display name of this result item based on request parameter language.
- `Address` object — The place's address.
- `Label` string, password — Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.
- `Country` object — The country component of the address.
- `Code2` string, password — Country, represented by its alpha 2-character code.
- `Code3` string, password — Country, represented by its alpha t-character code.
- `Name` string, password — Name of the country.
- `Region` object — The region or state results should be present in.
Example: North Rhine-Westphalia.
Abbreviated code for a the state, province or region of the country. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Example: BC.
Name for a the state, province, or region of the country.
Example: British Columbia.
ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
- `Name` string, password — Name for the county or sub-region.
- `Locality` string, password — The city or locality of the address.
Example: Vancouver.
A subdivision of a district.
Example: Minden-Lübbecke.
Name of the block. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Example: Sunny Mansion 203 block: 2 Chome
Name of sub-block. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Example: Sunny Mansion 203 sub-block: 4
Name of the streets in the intersection. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Example: ["Friedrichstraße","Unter den Linden"]
Components of the street. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Example: Yonge from "Yonge street".
- `BaseName` string, password —Base name part of the street name.
Example: Younge from the "Younge street".
- `Type` string, password —Street type part of the street name.
Example: "avenue".
"" or " " between the base name and type.
- `Prefix` string, password — A prefix is a directional identifier that precedes, but is not included in, the base name of a road.
Example: E for East.
- `Suffix` string, password —A suffix is a directional identifier that follows, but is not included in, the base name of a road.
Example W for West.
- `Direction` string, password — Indicates the official directional identifiers assigned to highways. - `Language` string — A BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. - `AddressNumber` string, password — The number that identifies an address within a street. - `Building` string, password — The name of the building at the address. Not available inap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
- `SecondaryAddressComponents` SecondaryAddressComponent[] — Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Coverage for Address.SecondaryAddressComponents is available in the following countries:
AUS, CAN, NZL, USA, PRI
The designator of the secondary address component.
Example: Apt.
ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
- `PostalCodeDetails` PostalCodeDetails[] — Contains details about the postal code of the place/result. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
- `PostalCode` string, password — An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should possess.
- `PostalAuthority` 'Usps', password — The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.
- `PostalCodeType` 'UspsZip' | 'UspsZipPlus4', password — The postal code type.
- `UspsZip` object — The ZIP Classification Code, or in other words what type of postal code is it.
- `ZipClassificationCode` 'Military' | 'PostOfficeBoxes' | 'Unique', password — The ZIP Classification Code, or in other words what type of postal code is it.
- `UspsZipPlus4` object — The USPS ZIP+4 Record Type Code.
- `RecordTypeCode` 'Firm' | 'General' | 'HighRise' | 'PostOfficeBox' | 'Rural' | 'Street', password — The USPS ZIP+4 Record Type Code.
- `Position` Double[] — The position in World Geodetic System (WGS 84) format: [longitude, latitude].
- `Distance` integer — The distance in meters from the QueryPosition.
- `MapView` Double[] — The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
- `LocalizedName` string, password, required — Localized name of the food type.
- `Id` string, password — The Food Type Id.
- `Primary` boolean — Boolean which indicates if this food type is the primary offered by the place. For example, if a location serves fast food, but also dessert, he primary would likely be fast food.
- `AccessPoints` AccessPoint[] — Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude]. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
- `Position` Double[] — The position in World Geodetic System (WGS 84) format: [longitude, latitude].
- `Type` 'Delivery' | 'Emergency' | 'Entrance' | 'Loading' | 'Other' | 'Parking' | 'Taxi' — The type of access point, indicating its intended use. Only applies to results of type place.
- `Primary` boolean — Set to true for the primary access position when the place has more than one access point.
- `Label` string, password — A short textual description of the access point, such as "North Entrance".
- `TimeZone` object — The time zone in which the place is located.
- `Name` string, password, required — The time zone name.
- `Offset` string, password — Time zone offset of the timezone from UTC.
- `OffsetSeconds` integer — The offset of the time zone from UTC, in seconds.
- `PoliticalView` string, password — The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
- `Intersections` Intersection[] — All Intersections that are near the provided address. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
- `PlaceId` string, password, required — The PlaceId of the place result.
- `Title` string, password, required — The localized display name of this result item based on request parameter language.
- `Address` Address — The place address.
- `Label` string, password — Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.
- `Country` object — The country component of the address.
- `Code2` string, password — Country, represented by its alpha 2-character code.
- `Code3` string, password — Country, represented by its alpha t-character code.
- `Name` string, password — Name of the country.
- `Region` object — The region or state results should be present in.
Example: North Rhine-Westphalia.
Abbreviated code for a the state, province or region of the country. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Example: BC.
Name for a the state, province, or region of the country.
Example: British Columbia.
ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
- `Name` string, password — Name for the county or sub-region.
- `Locality` string, password — The city or locality of the address.
Example: Vancouver.
A subdivision of a district.
Example: Minden-Lübbecke.
Name of the block. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Example: Sunny Mansion 203 block: 2 Chome
Name of sub-block. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Example: Sunny Mansion 203 sub-block: 4
Name of the streets in the intersection. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Example: ["Friedrichstraße","Unter den Linden"]
Components of the street. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Example: Yonge from "Yonge street".
- `BaseName` string, password —Base name part of the street name.
Example: Younge from the "Younge street".
- `Type` string, password —Street type part of the street name.
Example: "avenue".
"" or " " between the base name and type.
- `Prefix` string, password — A prefix is a directional identifier that precedes, but is not included in, the base name of a road.
Example: E for East.
- `Suffix` string, password —A suffix is a directional identifier that follows, but is not included in, the base name of a road.
Example W for West.
- `Direction` string, password — Indicates the official directional identifiers assigned to highways. - `Language` string — A BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. - `AddressNumber` string, password — The number that identifies an address within a street. - `Building` string, password — The name of the building at the address. Not available inap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
- `SecondaryAddressComponents` SecondaryAddressComponent[] — Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Coverage for Address.SecondaryAddressComponents is available in the following countries:
AUS, CAN, NZL, USA, PRI
The designator of the secondary address component.
Example: Apt.
The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set of four coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
true for the primary access position when the place has more than one access point.
- `Label` string, password — A short textual description of the access point, such as "North Entrance".
- `MainAddress` object — The main address corresponding to a place of type Secondary Address.
- `PlaceId` string, password, required — The PlaceId of the place result.
- `PlaceType` 'Country' | 'Region' | 'SubRegion' | 'Locality' | 'District' | 'SubDistrict' | 'PostalCode' | 'Block' | 'SubBlock' | 'Intersection' | 'Street' | 'PointOfInterest' | 'PointAddress' | 'InterpolatedAddress' | 'SecondaryAddress' | 'InferredSecondaryAddress', password, required — A PlaceType is a category that the result place must belong to.
- `Title` string, password, required — The localized display name of this result item based on request parameter language.
- `Address` Address — The place address.
- `Label` string, password — Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.
- `Country` object — The country component of the address.
- `Code2` string, password — Country, represented by its alpha 2-character code.
- `Code3` string, password — Country, represented by its alpha t-character code.
- `Name` string, password — Name of the country.
- `Region` object — The region or state results should be present in.
Example: North Rhine-Westphalia.
Abbreviated code for a the state, province or region of the country. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Example: BC.
Name for a the state, province, or region of the country.
Example: British Columbia.
ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
- `Name` string, password — Name for the county or sub-region.
- `Locality` string, password — The city or locality of the address.
Example: Vancouver.
A subdivision of a district.
Example: Minden-Lübbecke.
Name of the block. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Example: Sunny Mansion 203 block: 2 Chome
Name of sub-block. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Example: Sunny Mansion 203 sub-block: 4
Name of the streets in the intersection. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Example: ["Friedrichstraße","Unter den Linden"]
Components of the street. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Example: Yonge from "Yonge street".
- `BaseName` string, password —Base name part of the street name.
Example: Younge from the "Younge street".
- `Type` string, password —Street type part of the street name.
Example: "avenue".
"" or " " between the base name and type.
- `Prefix` string, password — A prefix is a directional identifier that precedes, but is not included in, the base name of a road.
Example: E for East.
- `Suffix` string, password —A suffix is a directional identifier that follows, but is not included in, the base name of a road.
Example W for West.
- `Direction` string, password — Indicates the official directional identifiers assigned to highways. - `Language` string — A BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. - `AddressNumber` string, password — The number that identifies an address within a street. - `Building` string, password — The name of the building at the address. Not available inap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
- `SecondaryAddressComponents` SecondaryAddressComponent[] — Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Coverage for Address.SecondaryAddressComponents is available in the following countries:
AUS, CAN, NZL, USA, PRI
The designator of the secondary address component.
Example: Apt.
true for the primary access position when the place has more than one access point.
- `Label` string, password — A short textual description of the access point, such as "North Entrance".
- `EstimatedPointAddress` boolean — If true, indicates that the coordinates of the position and access points of the point address are estimated.
## Other responses
- `480` — InternalServerException
- `481` — AccessDeniedException
- `482` — ValidationException
- `483` — ThrottlingException
---
[API](https://skmtc.net/aws/apis/geo-places.md) · [All operations](https://skmtc.net/aws/apis/geo-places/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/geo-places/versions/2c2d7ff49bea/schema)