The region or state results should be to be present in.
Example: North Rhine-Westphalia.
The city or locality results should be present in.
Example: Vancouver.
An optional limit for the number of results returned in a single call.
Default value: 20
- `BiasPosition` Double[] — The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in[lng, lat] and in the WGS 84 format.
- `Filter` object — Geocode structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
- `IncludeCountries` CountryCode[] — A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
- `IncludePlaceTypes` GeocodeFilterPlaceType[] — The included place types.
- `AdditionalFeatures` GeocodeAdditionalFeature[] — A list of optional additional parameters, such as time zone, that can be requested for each result.
- `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.
- `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.
- `IntendedUse` 'SingleUse' | 'Storage' — Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored). Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
When storing Geocode 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.
PostalCodeMode affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the value EnumerateSpannedLocalities, all cities in that postal code are returned. If it's populated with the value EnumerateSpannedDistricts, all combinations of the postal code with the corresponding district and city names are returned.
- `AddressTranslations` AddressTranslationComponent[] — Specifies which address components to include translations for. Translations include all name variants and alternative names for the requested fields in all available languages. Valid values are District, Locality, Region, and SubRegion.
- `AddressNamesMode` 'Matched' | 'Administrative' — Specifies how address names are returned. If not set, the service returns normalized (official) names by default. When set to Matched, address names in the response are based on the input query rather than official names. When set to Administrative, the service returns the official administrative names for address components. Administrative currently applies only to addresses in the United States.
## Response `200`
Success
- GeocodeResponse
- `ResultItems` GeocodeResultItem[] — List of places or results returned for a query.
- `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` 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.
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}]
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.
- `MatchScores` object — Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
- `Overall` number, double — Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
- `Components` object — Indicates how well the component input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
- `Title` number, double — Indicates the match score of the title in the text query that match the found title.
- `Address` object — The place's address.
- `Country` number, double — The alpha-2 or alpha-3 character code for the country that the results will be present in.
- `Region` number, double — The region or state results should be to be present in.
Example: North Rhine-Westphalia.
The city or locality results should be present in.
Example: Vancouver.
A subdivision of a district.
Example: Minden-Lübbecke
Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
Name of the streets in the intersection.
Example: ["Friedrichstraße","Unter den Linden"]
Match scores for the secondary address components in the result.
Coverage for this functionality is available in the following countries: AUS, AUT, BRA, CAN, ESP, FRA, GBR, IDN, IND, NZL, TUR, TWN, USA.
language.
- `StartIndex` integer — Start index of the parsed query component.
- `EndIndex` integer — End index of the parsed query component.
- `Value` string, password — Value of the parsed query component.
- `QueryComponent` string, password — The address component that the parsed query component corresponds to.
- `Address` object — The place address.
- `Country` ParsedQueryComponent[] — The alpha-2 or alpha-3 character code for the country that the results will be present in.
- `StartIndex` integer — Start index of the parsed query component.
- `EndIndex` integer — End index of the parsed query component.
- `Value` string, password — Value of the parsed query component.
- `QueryComponent` string, password — The address component that the parsed query component corresponds to.
- `Region` ParsedQueryComponent[] — The region or state results should be present in.
Example: North Rhine-Westphalia.
The city or locality of the address.
Example: Vancouver.
A subdivision of a district.
Example: Minden-Lübbecke.
Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
Parsed secondary address components from the provided query text.
Coverage for ParsedQuery.Address.SecondaryAddressComponents is available in the following countries:
AUS, AUT, BRA, CAN, ESP, FRA, GBR, HKG, IDN, IND, NZL, TUR, TWN, USA
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".
- `SecondaryAddresses` RelatedPlace[] — All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information.
Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI.
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".
- `Translations` object — All name translations and alternative names for the requested address fields in all available languages.
- `Locality` AdminNames[] — A list of administrative names and translations for the locality address component.
- `Names` TranslationName[], required — A list of translation names for the administrative address component, including name variants and translations in available languages.
- `Value` string, password, required — The translated or alternative name value.
- `Language` string — A BCP 47 compliant language code for the translation name.
- `Type` 'Abbreviation' | 'AreaCode' | 'BaseName' | 'Exonym' | 'Shortened' | 'Synonym', required — The type of translation name. Valid values are Abbreviation, AreaCode, BaseName, Exonym, Shortened, and Synonym.
- `Primary` boolean — If true, indicates this is the primary name variant for the given language.
- `Transliterated` boolean — If true, indicates this name is a transliterated version rather than a native script translation.
- `Preference` 'Alternative' | 'Primary' — Indicates the preference level of the administrative name. Valid values are Primary and Alternative.
- `Region` AdminNames[] — A list of administrative names and translations for the region address component.
- `Names` TranslationName[], required — A list of translation names for the administrative address component, including name variants and translations in available languages.
- `Value` string, password, required — The translated or alternative name value.
- `Language` string — A BCP 47 compliant language code for the translation name.
- `Type` 'Abbreviation' | 'AreaCode' | 'BaseName' | 'Exonym' | 'Shortened' | 'Synonym', required — The type of translation name. Valid values are Abbreviation, AreaCode, BaseName, Exonym, Shortened, and Synonym.
- `Primary` boolean — If true, indicates this is the primary name variant for the given language.
- `Transliterated` boolean — If true, indicates this name is a transliterated version rather than a native script translation.
- `Preference` 'Alternative' | 'Primary' — Indicates the preference level of the administrative name. Valid values are Primary and Alternative.
- `District` AdminNames[] — A list of administrative names and translations for the district address component.
- `Names` TranslationName[], required — A list of translation names for the administrative address component, including name variants and translations in available languages.
- `Value` string, password, required — The translated or alternative name value.
- `Language` string — A BCP 47 compliant language code for the translation name.
- `Type` 'Abbreviation' | 'AreaCode' | 'BaseName' | 'Exonym' | 'Shortened' | 'Synonym', required — The type of translation name. Valid values are Abbreviation, AreaCode, BaseName, Exonym, Shortened, and Synonym.
- `Primary` boolean — If true, indicates this is the primary name variant for the given language.
- `Transliterated` boolean — If true, indicates this name is a transliterated version rather than a native script translation.
- `Preference` 'Alternative' | 'Primary' — Indicates the preference level of the administrative name. Valid values are Primary and Alternative.
- `SubRegion` AdminNames[] — A list of administrative names and translations for the sub-region address component.
- `Names` TranslationName[], required — A list of translation names for the administrative address component, including name variants and translations in available languages.
- `Value` string, password, required — The translated or alternative name value.
- `Language` string — A BCP 47 compliant language code for the translation name.
- `Type` 'Abbreviation' | 'AreaCode' | 'BaseName' | 'Exonym' | 'Shortened' | 'Synonym', required — The type of translation name. Valid values are Abbreviation, AreaCode, BaseName, Exonym, Shortened, and Synonym.
- `Primary` boolean — If true, indicates this is the primary name variant for the given language.
- `Transliterated` boolean — If true, indicates this name is a transliterated version rather than a native script translation.
- `Preference` 'Alternative' | 'Primary' — Indicates the preference level of the administrative name. Valid values are Primary and Alternative.
- `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)