The Places API enables powerful location search and geocoding capabilities for your applications, offering global coverage with rich, detailed information. Key features include:
Forward and reverse geocoding for addresses and coordinates
Comprehensive place searches with detailed information, including:
Business names and addresses
Contact information
Hours of operation
POI (Points of Interest) categories
Food types for restaurants
Chain affiliation for relevant businesses
Global data coverage with a wide range of POI categories
Regular data updates to ensure accuracy and relevance
Autocomplete completes potential places and addresses as the user types, based on the partial input. The API enhances the efficiency and accuracy of address by completing query based on a few entered keystrokes. It helps you by completing partial queries with valid address completion. Also, the API supports the filtering of results based on geographic location, country, or specific place types, and can be tailored using optional parameters like language and political views.
Geocode converts a textual address or place into geographic coordinates. You can obtain geographic coordinates, address component, and other related information. It supports flexible queries, including free-form text or structured queries with components like street names, postal codes, and regions. The Geocode API can also provide additional features such as time zone information and the inclusion of political views.
GetPlace finds a place by its unique ID. A PlaceId is returned by other place operations.
ReverseGeocode converts geographic coordinates into a human-readable address or place. You can obtain address component, and other related information such as place type, category, street information. The Reverse Geocode API supports filtering to on place type so that you can refine result based on your need. Also, The Reverse Geocode API can also provide additional features such as time zone information and the inclusion of political views.
SearchNearby queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more. The API returns details such as a place name, address, phone, category, food type, contact, opening hours. Also, the API can return phonemes, time zones and more based on requested parameters.
SearchText searches for geocode and place information. You can then complete a follow-up query suggested from the Suggest API via a query id.
Suggest provides intelligent predictions or recommendations based on the user's input or context, such as relevant places, points of interest, query terms or search category. It is designed to help users find places or point of interests candidates or identify a follow on query based on incomplete or misspelled queries. It returns a list of possible matches or refinements that can be used to formulate a more accurate query. Users can select the most appropriate suggestion and use it for further searching. The API provides options for filtering results by location and other attributes, and allows for additional features like phonemes and timezones. The response includes refined query terms and detailed place information.
You don't have sufficient access to perform this action.
", "refs": {} }, "AccessPoint": { "base": "Position of the access point represented by longitude and latitude for a vehicle.
", "refs": { "AccessPointList$member": null } }, "AccessPointList": { "base": null, "refs": { "GeocodeResultItem$AccessPoints": "Position of the access point represented by longitude and latitude.
", "GetPlaceResponse$AccessPoints": "Position of the access point in (lng,lat).
Position of the access point represented by longitude and latitude.
", "RelatedPlace$AccessPoints": "Position of the access point represented by longitude and latitude.
", "ReverseGeocodeResultItem$AccessPoints": "Position of the access point represented by longitude and latitude.
", "SearchNearbyResultItem$AccessPoints": "Position of the access point represent by longitude and latitude.
", "SearchTextResultItem$AccessPoints": "Position of the access point represent by longitude and latitude.
", "SuggestPlaceResult$AccessPoints": "Position of the access point represent by longitude and latitude.
" } }, "AccessRestriction": { "base": "Indicates if the access location is restricted. Index correlates to that of an access point and indicates if access through this point has some form of restriction.
", "refs": { "AccessRestrictionList$member": null } }, "AccessRestrictionList": { "base": null, "refs": { "GetPlaceResponse$AccessRestrictions": "Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.
", "SearchNearbyResultItem$AccessRestrictions": "Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.
", "SearchTextResultItem$AccessRestrictions": "Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.
", "SuggestPlaceResult$AccessRestrictions": "Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.
" } }, "Address": { "base": "The place address.
", "refs": { "AutocompleteResultItem$Address": "The address associated with this result.
", "GeocodeResultItem$Address": "The place's address.
", "GetPlaceResponse$Address": "The place's address.
", "Intersection$Address": null, "RelatedPlace$Address": null, "ReverseGeocodeResultItem$Address": "The place's address.
", "SearchNearbyResultItem$Address": "The place's address.
", "SearchTextResultItem$Address": "The place's address.
", "SuggestPlaceResult$Address": "The place's address.
" } }, "AddressAddressNumberString": { "base": null, "refs": { "Address$AddressNumber": "The number that identifies an address within a street.
" } }, "AddressBlockString": { "base": null, "refs": { "Address$Block": "Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
The name of the building at the address.
" } }, "AddressComponentMatchScores": { "base": "Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
", "refs": { "ComponentMatchScores$Address": "The place's address.
" } }, "AddressComponentMatchScoresIntersectionList": { "base": null, "refs": { "AddressComponentMatchScores$Intersection": "Name of the streets in the intersection.
Example: [\"Friedrichstraße\",\"Unter den Linden\"]
How to pronounce the various components of the address or place.
", "refs": { "PhonemeDetails$Address": "How to pronounce the address.
" } }, "AddressDistrictString": { "base": null, "refs": { "Address$District": "The district or division of a locality associated with this address.
" } }, "AddressLabelString": { "base": null, "refs": { "Address$Label": "Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.
" } }, "AddressLocalityString": { "base": null, "refs": { "Address$Locality": "The city or locality of the address.
Example: Vancouver.
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.
" } }, "AddressStreetString": { "base": null, "refs": { "Address$Street": "The name of the street results should be present in.
" } }, "AddressSubBlockString": { "base": null, "refs": { "Address$SubBlock": "Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
A subdivision of a district.
Example: Minden-Lübbecke.
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "GeocodeRequest$Key": "Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "GetPlaceRequest$Key": "Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "ReverseGeocodeRequest$Key": "Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "SearchNearbyRequest$Key": "Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "SearchTextRequest$Key": "Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "SuggestRequest$Key": "Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
" } }, "AutocompleteAdditionalFeature": { "base": null, "refs": { "AutocompleteAdditionalFeatureList$member": null } }, "AutocompleteAdditionalFeatureList": { "base": null, "refs": { "AutocompleteRequest$AdditionalFeatures": "A list of optional additional parameters that can be requested for each result.
" } }, "AutocompleteAddressHighlights": { "base": "Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.
", "refs": { "AutocompleteHighlights$Address": "Describes how part of the result address match the input query.
" } }, "AutocompleteFilter": { "base": "Autocomplete structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
", "refs": { "AutocompleteRequest$Filter": "A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" } }, "AutocompleteFilterPlaceType": { "base": null, "refs": { "AutocompleteFilterPlaceTypeList$member": null } }, "AutocompleteFilterPlaceTypeList": { "base": null, "refs": { "AutocompleteFilter$IncludePlaceTypes": "The included place types.
" } }, "AutocompleteHighlights": { "base": "Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.
", "refs": { "AutocompleteResultItem$Highlights": "Indicates the starting and ending index of the place in the text query that match the found title.
" } }, "AutocompleteIntendedUse": { "base": null, "refs": { "AutocompleteRequest$IntendedUse": "Indicates if the results will be stored. Defaults to SingleUse, if left empty.
An optional limit for the number of results returned in a single call.
" } }, "AutocompleteRequestQueryTextString": { "base": null, "refs": { "AutocompleteRequest$QueryText": "The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.
The fields QueryText, and QueryID are mutually exclusive.
A result matching the input query text.
", "refs": { "AutocompleteResultItemList$member": null } }, "AutocompleteResultItemList": { "base": null, "refs": { "AutocompleteResponse$ResultItems": "List of places or results returned for a query.
" } }, "AutocompleteResultItemPlaceIdString": { "base": null, "refs": { "AutocompleteResultItem$PlaceId": "The PlaceId of the place associated with this result. This can be used to look up additional details about the result via GetPlace.
" } }, "AutocompleteResultItemTitleString": { "base": null, "refs": { "AutocompleteResultItem$Title": "A formatted string for display when presenting this result to an end user.
" } }, "BoundingBox": { "base": null, "refs": { "AutocompleteFilter$BoundingBox": "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}]
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}]
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}]
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}]
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}]
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}]
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}]
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}]
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}]
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}]
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}]
A businesschain is a chain of businesses that belong to the same brand. For example 7-11.
The Business Chain Id.
" } }, "BusinessChainList": { "base": null, "refs": { "GetPlaceResponse$BusinessChains": "The Business Chains associated with the place.
", "SearchNearbyResultItem$BusinessChains": "The Business Chains associated with the place.
", "SearchTextResultItem$BusinessChains": "The Business Chains associated with the place.
", "SuggestPlaceResult$BusinessChains": "The Business Chains associated with the place.
" } }, "BusinessChainNameString": { "base": null, "refs": { "BusinessChain$Name": "The business chain name.
" } }, "Category": { "base": "Category of the Place returned.
The category ID.
" } }, "CategoryList": { "base": null, "refs": { "AccessRestriction$Categories": "Categories of results that results must belong too.
", "ContactDetails$Categories": "Categories of results that results must belong too.
", "GeocodeResultItem$Categories": "Categories of results that results must belong to.
", "GetPlaceResponse$Categories": "Categories of results that results must belong to.
", "OpeningHours$Categories": "Categories of results that results must belong too.
", "ReverseGeocodeResultItem$Categories": "Categories of results that results must belong to.
", "SearchNearbyResultItem$Categories": "Categories of results that results must belong to.
", "SearchTextResultItem$Categories": "Categories of results that results must belong to.
", "SuggestPlaceResult$Categories": "Categories of results that results must belong to.
" } }, "CategoryLocalizedNameString": { "base": null, "refs": { "Category$LocalizedName": "Localized name of the category type.
" } }, "CategoryNameString": { "base": null, "refs": { "Category$Name": "The category name.
" } }, "ComponentMatchScores": { "base": "Indicates how well the returned title and address components matches the input TextQuery. For each component a score is provied with 1 indicating all tokens were matched and 0 indicating no tokens were matched.
", "refs": { "MatchScoreDetails$Components": "Indicates how well the component input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
" } }, "ContactDetails": { "base": "Details related to contacts.
", "refs": { "ContactDetailsList$member": null } }, "ContactDetailsLabelString": { "base": null, "refs": { "ContactDetails$Label": "The contact's label.
" } }, "ContactDetailsList": { "base": null, "refs": { "Contacts$Phones": "List of phone numbers for the results contact.
", "Contacts$Faxes": "List of fax addresses for the result contact.
", "Contacts$Websites": "List of website URLs that belong to the result.
", "Contacts$Emails": "List of emails for contacts of the result.
" } }, "ContactDetailsValueString": { "base": null, "refs": { "ContactDetails$Value": "The contact's value.
" } }, "Contacts": { "base": "A list of potential contact methods for the result/place.
", "refs": { "GetPlaceResponse$Contacts": "List of potential contact methods for the result/place.
", "SearchNearbyResultItem$Contacts": "List of potential contact methods for the result/place.
", "SearchTextResultItem$Contacts": "List of potential contact methods for the result/place.
" } }, "Country": { "base": "The alpha-2 or alpha-3 character code for the country that the results will be present in.
", "refs": { "Address$Country": "The country component of the address.
" } }, "CountryCode": { "base": null, "refs": { "AutocompleteRequest$PoliticalView": "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.
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
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
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.
", "GetPlaceRequest$PoliticalView": "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.
", "ReverseGeocodeRequest$PoliticalView": "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.
", "SearchNearbyRequest$PoliticalView": "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.
", "SearchTextRequest$PoliticalView": "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.
", "SuggestRequest$PoliticalView": "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.
" } }, "CountryCode2": { "base": null, "refs": { "Country$Code2": "Country, represented by its alpha 2-character code.
" } }, "CountryCode3": { "base": null, "refs": { "AutocompleteResultItem$PoliticalView": "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.
", "Country$Code3": "Country, represented by its alpha t-character code.
", "GeocodeResultItem$PoliticalView": "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.
", "GetPlaceResponse$PoliticalView": "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.
", "ReverseGeocodeResultItem$PoliticalView": "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.
", "SearchNearbyResultItem$PoliticalView": "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.
", "SearchTextResultItem$PoliticalView": "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.
", "SuggestPlaceResult$PoliticalView": "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.
" } }, "CountryCodeList": { "base": null, "refs": { "AutocompleteFilter$IncludeCountries": "A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
", "GeocodeFilter$IncludeCountries": "A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
", "SearchNearbyFilter$IncludeCountries": "A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
", "SearchTextFilter$IncludeCountries": "A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
", "SuggestFilter$IncludeCountries": "A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
" } }, "CountryHighlights": { "base": "Indicates the starting and ending index of the country in the text query that match the found title.
", "refs": { "AutocompleteAddressHighlights$Country": "The alpha-2 or alpha-3 character code for the country that the results will be present in.
" } }, "CountryNameString": { "base": null, "refs": { "Country$Name": "Name of the country.
" } }, "DistanceMeters": { "base": null, "refs": { "AutocompleteResultItem$Distance": "The distance in meters between the center of the search area and this result. Useful to evaluate how far away from the original bias position the result is.
", "GeocodeResultItem$Distance": "The distance in meters from the QueryPosition.
", "Intersection$Distance": "The distance in meters from the QueryPosition.
", "Intersection$RouteDistance": "The distance from the routing position of the nearby address to the street result.
", "ReverseGeocodeResultItem$Distance": "The distance in meters from the QueryPosition.
", "SearchNearbyResultItem$Distance": "The distance in meters from the QueryPosition.
", "SearchTextResultItem$Distance": "The distance in meters from the QueryPosition.
", "SuggestPlaceResult$Distance": "The distance in meters from the QueryPosition.
" } }, "Double": { "base": null, "refs": { "BoundingBox$member": null, "Position$member": null } }, "FilterBusinessChainList": { "base": null, "refs": { "SearchNearbyFilter$IncludeBusinessChains": "The Business Chains associated with the place.
", "SearchNearbyFilter$ExcludeBusinessChains": "The Business Chains associated with the place.
" } }, "FilterBusinessChainListMemberString": { "base": null, "refs": { "FilterBusinessChainList$member": null } }, "FilterCategoryList": { "base": null, "refs": { "SearchNearbyFilter$IncludeCategories": "Categories of results that results must belong too.
", "SearchNearbyFilter$ExcludeCategories": "Categories of results that results are excluded from.
" } }, "FilterCategoryListMemberString": { "base": null, "refs": { "FilterCategoryList$member": null } }, "FilterCircle": { "base": "The Circle that all results must be in.
The radius, in meters, of the FilterCircle.
Food types that results are included from.
", "SearchNearbyFilter$ExcludeFoodTypes": "Food types that results are excluded from.
" } }, "FilterFoodTypeListMemberString": { "base": null, "refs": { "FilterFoodTypeList$member": null } }, "FoodType": { "base": "List of Food types offered by this result.
The Food Type Id.
" } }, "FoodTypeList": { "base": null, "refs": { "GeocodeResultItem$FoodTypes": "List of food types offered by this result.
", "GetPlaceResponse$FoodTypes": "List of food types offered by this result.
", "ReverseGeocodeResultItem$FoodTypes": "List of food types offered by this result.
", "SearchNearbyResultItem$FoodTypes": "List of food types offered by this result.
", "SearchTextResultItem$FoodTypes": "List of food types offered by this result.
", "SuggestPlaceResult$FoodTypes": "List of food types offered by this result.
" } }, "FoodTypeLocalizedNameString": { "base": null, "refs": { "FoodType$LocalizedName": "Localized name of the food type.
" } }, "GeocodeAdditionalFeature": { "base": null, "refs": { "GeocodeAdditionalFeatureList$member": null } }, "GeocodeAdditionalFeatureList": { "base": null, "refs": { "GeocodeRequest$AdditionalFeatures": "A list of optional additional parameters, such as time zone, that can be requested for each result.
" } }, "GeocodeFilter": { "base": "Geocode structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
", "refs": { "GeocodeRequest$Filter": "A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" } }, "GeocodeFilterPlaceType": { "base": null, "refs": { "GeocodeFilterPlaceTypeList$member": null } }, "GeocodeFilterPlaceTypeList": { "base": null, "refs": { "GeocodeFilter$IncludePlaceTypes": "The included place types.
" } }, "GeocodeIntendedUse": { "base": null, "refs": { "GeocodeRequest$IntendedUse": "Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Storing the response of an Geocode query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.
Parsed components in the provided QueryText.
", "refs": { "GeocodeResultItem$ParsedQuery": "Free-form text query.
" } }, "GeocodeParsedQueryAddressComponents": { "base": "Parsed address components in the provided QueryText.
", "refs": { "GeocodeParsedQuery$Address": "The place address.
" } }, "GeocodeQueryComponents": { "base": "A structured free text query allows you to search for places by the name or text representation of specific properties of the place.
", "refs": { "GeocodeRequest$QueryComponents": null } }, "GeocodeQueryComponentsAddressNumberString": { "base": null, "refs": { "GeocodeQueryComponents$AddressNumber": "The house number or address results should have.
" } }, "GeocodeQueryComponentsCountryString": { "base": null, "refs": { "GeocodeQueryComponents$Country": "The alpha-2 or alpha-3 character code for the country that the results will be present in.
" } }, "GeocodeQueryComponentsDistrictString": { "base": null, "refs": { "GeocodeQueryComponents$District": "The district or division of a city the results should be present in.
" } }, "GeocodeQueryComponentsLocalityString": { "base": null, "refs": { "GeocodeQueryComponents$Locality": "The city or locality results should be present in.
Example: Vancouver.
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.
" } }, "GeocodeQueryComponentsRegionString": { "base": null, "refs": { "GeocodeQueryComponents$Region": "The region or state results should be to be present in.
Example: North Rhine-Westphalia.
The name of the street results should be present in.
" } }, "GeocodeQueryComponentsSubRegionString": { "base": null, "refs": { "GeocodeQueryComponents$SubRegion": "The sub-region or county for which results should be present in.
" } }, "GeocodeRequest": { "base": null, "refs": {} }, "GeocodeRequestMaxResultsInteger": { "base": null, "refs": { "GeocodeRequest$MaxResults": "An optional limit for the number of results returned in a single call.
" } }, "GeocodeRequestQueryTextString": { "base": null, "refs": { "GeocodeRequest$QueryText": "The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.
The fields QueryText, and QueryID are mutually exclusive.
The Geocoded result.
", "refs": { "GeocodeResultItemList$member": null } }, "GeocodeResultItemList": { "base": null, "refs": { "GeocodeResponse$ResultItems": "List of places or results returned for a query.
" } }, "GeocodeResultItemPlaceIdString": { "base": null, "refs": { "GeocodeResultItem$PlaceId": "The PlaceId of the place result.
The localized display name of this result item based on request parameter language.
A list of optional additional parameters such as time zone that can be requested for each result.
" } }, "GetPlaceIntendedUse": { "base": null, "refs": { "GetPlaceRequest$IntendedUse": "Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Storing the response of an GetPlace query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.
The PlaceId of the place you wish to receive the information for.
The PlaceId of the place you wish to receive the information for.
The localized display name of this result item based on request parameter language.
Indicates the starting and ending index of the text query that match the found title.
", "refs": { "HighlightList$member": null } }, "HighlightEndIndexInteger": { "base": null, "refs": { "Highlight$EndIndex": "End index of the highlight.
" } }, "HighlightList": { "base": null, "refs": { "AutocompleteAddressHighlights$Label": "Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.
", "AutocompleteAddressHighlights$Locality": "The city or locality results should be present in.
Example: Vancouver.
The district or division of a city the results should be present in.
", "AutocompleteAddressHighlights$SubDistrict": "Indicates the starting and ending index of the title in the text query that match the found title.
", "AutocompleteAddressHighlights$Street": "The name of the street results should be present in.
", "AutocompleteAddressHighlights$Block": "Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
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.
", "AutocompleteAddressHighlights$AddressNumber": "The house number or address results should have.
", "AutocompleteAddressHighlights$Building": "The name of the building at the address.
", "AutocompleteHighlights$Title": "Indicates where the title field in the result matches the input query.
", "CountryHighlights$Code": "Indicates the starting and ending index of the country code in the text query that match the found title.
", "CountryHighlights$Name": "Indicates the starting and ending index of the country code in the text query that match the found title.
", "IntersectionHighlightsList$member": null, "RegionHighlights$Code": "Indicates the starting and ending index of the region in the text query that match the found title.
", "RegionHighlights$Name": "Indicates the starting and ending index of the region name in the text query that match the found title.
", "SubRegionHighlights$Code": "Indicates the starting and ending index of the sub-region in the text query that match the found title.
", "SubRegionHighlights$Name": "Indicates the starting and ending index of the name in the text query that match the found title.
", "SuggestAddressHighlights$Label": "Indicates the starting and ending indexes of the places in the result which were identified to match the textQuery. This result is useful for providing emphasis to results where the user query directly matched to make selecting the correct result from a list easier for an end user.
", "SuggestHighlights$Title": "Indicates the starting and ending index of the title in the text query that match the found title.
" } }, "HighlightStartIndexInteger": { "base": null, "refs": { "Highlight$StartIndex": "Start index of the highlight.
" } }, "HighlightValueString": { "base": null, "refs": { "Highlight$Value": "The highlight's value.
" } }, "InternalServerException": { "base": "The request processing has failed because of an unknown error, exception or failure.
", "refs": {} }, "Intersection": { "base": "All Intersections that are near the provided address.
", "refs": { "IntersectionList$member": null } }, "IntersectionHighlightsList": { "base": null, "refs": { "AutocompleteAddressHighlights$Intersection": "Name of the streets in the intersection. For example: e.g. [\"Friedrichstraße\",\"Unter den Linden\"]
" } }, "IntersectionList": { "base": null, "refs": { "GeocodeResultItem$Intersections": "All Intersections that are near the provided address.
", "ReverseGeocodeResultItem$Intersections": "All Intersections that are near the provided address.
" } }, "IntersectionPlaceIdString": { "base": null, "refs": { "Intersection$PlaceId": "The PlaceId of the place result.
Name of the streets in the intersection.
Example: [\"Friedrichstraße\",\"Unter den Linden\"]
The localized display name of this result item based on request parameter language.
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.
", "AutocompleteResultItem$Language": "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.
", "GeocodeRequest$Language": "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.
", "GetPlaceRequest$Language": "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.
", "PhonemeTranscription$Language": "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.
", "ReverseGeocodeRequest$Language": "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.
", "SearchNearbyRequest$Language": "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.
", "SearchTextRequest$Language": "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.
", "StreetComponents$Language": "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.
", "SuggestRequest$Language": "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.
" } }, "MatchScore": { "base": null, "refs": { "AddressComponentMatchScores$Country": "The alpha-2 or alpha-3 character code for the country that the results will be present in.
", "AddressComponentMatchScores$Region": "The region or state results should be to be present in.
Example: North Rhine-Westphalia.
The sub-region or county for which results should be present in.
", "AddressComponentMatchScores$Locality": "The city or locality results should be present in.
Example: Vancouver.
The district or division of a city the results should be present in.
", "AddressComponentMatchScores$SubDistrict": "A subdivision of a district.
Example: Minden-Lübbecke
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.
", "AddressComponentMatchScores$Block": "Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
The house number or address results should have.
", "AddressComponentMatchScores$Building": "The name of the building at the address.
", "AddressComponentMatchScoresIntersectionList$member": null, "ComponentMatchScores$Title": "Indicates the match score of the title in the text query that match the found title.
", "MatchScoreDetails$Overall": "Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
", "SecondaryAddressComponentMatchScore$Number": "Match score for the secondary address number.
" } }, "MatchScoreDetails": { "base": "Details related to the match score.
", "refs": { "GeocodeResultItem$MatchScores": "Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
" } }, "OpeningHours": { "base": "List of opening hours objects.
", "refs": { "OpeningHoursList$member": null } }, "OpeningHoursComponents": { "base": "Components of the opening hours object.
", "refs": { "OpeningHoursComponentsList$member": null } }, "OpeningHoursComponentsList": { "base": null, "refs": { "OpeningHours$Components": "Components of the opening hours object.
" } }, "OpeningHoursComponentsOpenDurationString": { "base": null, "refs": { "OpeningHoursComponents$OpenDuration": "String which represents the duration of the opening period, such as \"PT12H00M\".
String which represents the opening hours, such as \"T070000\".
Days or periods when the provided opening hours are in affect.
Example: FREQ:DAILY;BYDAY:MO,TU,WE,TH,SU
List of opening hours in the format they are displayed in. This can vary by result and in most cases represents how the result uniquely formats their opening hours.
" } }, "OpeningHoursList": { "base": null, "refs": { "GetPlaceResponse$OpeningHours": "List of opening hours objects.
", "SearchNearbyResultItem$OpeningHours": "List of opening hours objects.
", "SearchTextResultItem$OpeningHours": "List of opening hours objects.
" } }, "ParsedQueryComponent": { "base": "Parsed components in the provided QueryText.
", "refs": { "ParsedQueryComponentList$member": null } }, "ParsedQueryComponentEndIndexInteger": { "base": null, "refs": { "ParsedQueryComponent$EndIndex": "End index of the parsed query component.
" } }, "ParsedQueryComponentList": { "base": null, "refs": { "GeocodeParsedQuery$Title": "The localized display name of this result item based on request parameter language.
The alpha-2 or alpha-3 character code for the country that the results will be present in.
", "GeocodeParsedQueryAddressComponents$Region": "The region or state results should be present in.
Example: North Rhine-Westphalia.
The sub-region or county for which results should be present in.
", "GeocodeParsedQueryAddressComponents$Locality": "The city or locality of the address.
Example: Vancouver.
The district or division of a city the results should be present in.
", "GeocodeParsedQueryAddressComponents$SubDistrict": "A subdivision of a district.
Example: Minden-Lübbecke.
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.
", "GeocodeParsedQueryAddressComponents$Block": "Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
The name of the street results should be present in.
", "GeocodeParsedQueryAddressComponents$AddressNumber": "The number that identifies an address within a street.
", "GeocodeParsedQueryAddressComponents$Building": "The name of the building at the address.
" } }, "ParsedQueryComponentQueryComponentString": { "base": null, "refs": { "ParsedQueryComponent$QueryComponent": "The address component that the parsed query component corresponds to.
" } }, "ParsedQueryComponentStartIndexInteger": { "base": null, "refs": { "ParsedQueryComponent$StartIndex": "Start index of the parsed query component.
" } }, "ParsedQueryComponentValueString": { "base": null, "refs": { "ParsedQueryComponent$Value": "Value of the parsed query component.
" } }, "ParsedQuerySecondaryAddressComponent": { "base": "Information about a secondary address component parsed from the query text.
", "refs": { "ParsedQuerySecondaryAddressComponentList$member": null } }, "ParsedQuerySecondaryAddressComponentDesignatorString": { "base": null, "refs": { "ParsedQuerySecondaryAddressComponent$Designator": "Secondary address designator provided in the query.
" } }, "ParsedQuerySecondaryAddressComponentEndIndexInteger": { "base": null, "refs": { "ParsedQuerySecondaryAddressComponent$EndIndex": "End index of the parsed secondary address component in the query text.
" } }, "ParsedQuerySecondaryAddressComponentList": { "base": null, "refs": { "GeocodeParsedQueryAddressComponents$SecondaryAddressComponents": "Parsed secondary address components from the provided query text.
" } }, "ParsedQuerySecondaryAddressComponentNumberString": { "base": null, "refs": { "ParsedQuerySecondaryAddressComponent$Number": "Secondary address number provided in the query.
" } }, "ParsedQuerySecondaryAddressComponentStartIndexInteger": { "base": null, "refs": { "ParsedQuerySecondaryAddressComponent$StartIndex": "Start index of the parsed secondary address component in the query text.
" } }, "ParsedQuerySecondaryAddressComponentValueString": { "base": null, "refs": { "ParsedQuerySecondaryAddressComponent$Value": "Value of the parsed secondary address component.
" } }, "PhonemeDetails": { "base": "The phoneme details.
", "refs": { "GetPlaceResponse$Phonemes": "How the various components of the result's address are pronounced in various languages.
", "SearchNearbyResultItem$Phonemes": "How the various components of the result's address are pronounced in various languages.
", "SearchTextResultItem$Phonemes": "How the various components of the result's address are pronounced in various languages.
", "SuggestPlaceResult$Phonemes": "How the various components of the result's address are pronounced in various languages.
" } }, "PhonemeTranscription": { "base": "How to pronounce the various components of the address or place.
", "refs": { "PhonemeTranscriptionList$member": null } }, "PhonemeTranscriptionList": { "base": null, "refs": { "AddressComponentPhonemes$Country": "The alpha-2 or alpha-3 character code for the country that the results will be present in.
", "AddressComponentPhonemes$Region": "How to pronounce the region or state results should be to be present in.
", "AddressComponentPhonemes$SubRegion": "How to pronounce the sub-region or county for which results should be present in.
", "AddressComponentPhonemes$Locality": "How to pronounce the city or locality results should be present in.
Example: Vancouver.
How to pronounce the district or division of a city results should be present in.
", "AddressComponentPhonemes$SubDistrict": "How to pronounce the sub-district or division of a city results should be present in.
", "AddressComponentPhonemes$Block": "How to pronounce the name of the block.
", "AddressComponentPhonemes$SubBlock": "How to pronounce the name of the sub-block.
", "AddressComponentPhonemes$Street": "How to pronounce the name of the street results should be present in.
", "PhonemeDetails$Title": "List of PhonemeTranscription. See PhonemeTranscription for fields.
Value which indicates how to pronounce the value.
" } }, "PlaceType": { "base": null, "refs": { "AutocompleteResultItem$PlaceType": "PlaceType describes the type of result entry returned.
", "GeocodeResultItem$PlaceType": "A PlaceType is a category that the result place must belong to.
A PlaceType is a category that the result place must belong to.
A PlaceType is a category that the result place must belong to.
A PlaceType is a category that the result place must belong to.
A PlaceType is a category that the result place must belong to.
A PlaceType is a category that the result place must belong to.
A PlaceType is a category that the result place must belong to.
The position, in longitude and latitude.
", "AutocompleteRequest$BiasPosition": "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 WSG84 format.
The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.
The center position, in longitude and latitude, of the FilterCircle.
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 WSG84 format.
The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.
The position in longitude and latitude.
", "GetPlaceResponse$Position": "The position, in longitude and latitude.
", "Intersection$Position": "The position, in longitude and latitude.
", "RelatedPlace$Position": "The position, in longitude and latitude.
", "ReverseGeocodeRequest$QueryPosition": "The position, in [lng, lat] for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position
The position in longitude and latitude.
", "SearchNearbyRequest$QueryPosition": "The position, in [lng, lat] for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position
The position in longitude and latitude.
", "SearchTextRequest$BiasPosition": "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 WSG84 format.
The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.
The position, in longitude and latitude.
", "SuggestPlaceResult$Position": "The position, in longitude and latitude.
", "SuggestRequest$BiasPosition": "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 WSG84 format.
The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.
The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.
" } }, "PostalCodeDetails": { "base": "Contains details about the postal code of the place or result.
", "refs": { "PostalCodeDetailsList$member": null } }, "PostalCodeDetailsList": { "base": null, "refs": { "GeocodeResultItem$PostalCodeDetails": "Contains details about the postal code of the place/result.
", "GetPlaceResponse$PostalCodeDetails": "Contains details about the postal code of the place/result.
", "ReverseGeocodeResultItem$PostalCodeDetails": "Contains details about the postal code of the place/result.
" } }, "PostalCodeDetailsPostalCodeString": { "base": null, "refs": { "PostalCodeDetails$PostalCode": "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.
" } }, "PostalCodeMode": { "base": null, "refs": { "AutocompleteRequest$PostalCodeMode": "The 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.
The postal code type.
" } }, "QueryRefinement": { "base": "Suggestions for refining individual query terms. Suggestions are returned as objects which note the term, suggested replacement, and its index in the query.
", "refs": { "QueryRefinementList$member": null } }, "QueryRefinementEndIndexInteger": { "base": null, "refs": { "QueryRefinement$EndIndex": "End index of the parsed query.
" } }, "QueryRefinementList": { "base": null, "refs": { "SuggestResponse$QueryRefinements": "Maximum number of query terms to be returned for use with a search text query.
" } }, "QueryRefinementOriginalTermString": { "base": null, "refs": { "QueryRefinement$OriginalTerm": "The sub-string of the original query that is replaced by this query term.
" } }, "QueryRefinementRefinedTermString": { "base": null, "refs": { "QueryRefinement$RefinedTerm": "The term that will be suggested to the user.
" } }, "QueryRefinementStartIndexInteger": { "base": null, "refs": { "QueryRefinement$StartIndex": "Start index of the parsed component.
" } }, "QueryType": { "base": null, "refs": { "SuggestQueryResult$QueryType": "The query type. Category queries will search for places which have an entry matching the given category, for example \"doctor office\". BusinessChain queries will search for instances of a given business.
" } }, "RecordTypeCode": { "base": null, "refs": { "UspsZipPlus4$RecordTypeCode": "The USPS ZIP+4 Record Type Code.
" } }, "Region": { "base": "The region or state results should be to be present in.
Example: North Rhine-Westphalia.
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.
Example: BC.
Indicates the starting and ending index of the region in the text query that match the found title.
", "refs": { "AutocompleteAddressHighlights$Region": "The region or state results should be to be present in.
Example: North Rhine-Westphalia.
Name for a the state, province, or region of the country.
Example: British Columbia.
Place that is related to the result item.
", "refs": { "GeocodeResultItem$MainAddress": "The main address corresponding to a place of type Secondary Address.
", "GetPlaceResponse$MainAddress": "The main address corresponding to a place of type Secondary Address.
", "RelatedPlaceList$member": null } }, "RelatedPlaceList": { "base": null, "refs": { "GeocodeResultItem$SecondaryAddresses": "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.
", "GetPlaceResponse$SecondaryAddresses": "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.
" } }, "RelatedPlacePlaceIdString": { "base": null, "refs": { "RelatedPlace$PlaceId": "The PlaceId of the place result.
The localized display name of this result item based on request parameter language.
A list of optional additional parameters, such as time zone that can be requested for each result.
" } }, "ReverseGeocodeFilter": { "base": "The included place types.
", "refs": { "ReverseGeocodeRequest$Filter": "A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" } }, "ReverseGeocodeFilterPlaceType": { "base": null, "refs": { "ReverseGeocodeFilterPlaceTypeList$member": null } }, "ReverseGeocodeFilterPlaceTypeList": { "base": null, "refs": { "ReverseGeocodeFilter$IncludePlaceTypes": "The included place types.
" } }, "ReverseGeocodeIntendedUse": { "base": null, "refs": { "ReverseGeocodeRequest$IntendedUse": "Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Storing the response of an ReverseGeocode query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.
An optional limit for the number of results returned in a single call.
" } }, "ReverseGeocodeRequestQueryRadiusLong": { "base": null, "refs": { "ReverseGeocodeRequest$QueryRadius": "The maximum distance in meters from the QueryPosition from which a result will be returned.
" } }, "ReverseGeocodeResponse": { "base": null, "refs": {} }, "ReverseGeocodeResultItem": { "base": "The returned location from the Reverse Geocode action.
List of places or results returned for a query.
" } }, "ReverseGeocodeResultItemPlaceIdString": { "base": null, "refs": { "ReverseGeocodeResultItem$PlaceId": "The PlaceId of the place you wish to receive the information for.
The localized display name of this result item based on request parameter language.
A list of optional additional parameters, such as time zone, that can be requested for each result.
" } }, "SearchNearbyFilter": { "base": "SearchNearby structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
", "refs": { "SearchNearbyRequest$Filter": "A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" } }, "SearchNearbyIntendedUse": { "base": null, "refs": { "SearchNearbyRequest$IntendedUse": "Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Storing the response of an SearchNearby query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.
An optional limit for the number of results returned in a single call.
" } }, "SearchNearbyRequestQueryRadiusLong": { "base": null, "refs": { "SearchNearbyRequest$QueryRadius": "The maximum distance in meters from the QueryPosition from which a result will be returned.
The fields QueryText, and QueryID are mutually exclusive.
The search results of nearby places.
", "refs": { "SearchNearbyResultItemList$member": null } }, "SearchNearbyResultItemList": { "base": null, "refs": { "SearchNearbyResponse$ResultItems": "List of places or results returned for a query.
" } }, "SearchNearbyResultItemPlaceIdString": { "base": null, "refs": { "SearchNearbyResultItem$PlaceId": "The PlaceId of the place you wish to receive the information for.
The item's title.
" } }, "SearchTextAdditionalFeature": { "base": null, "refs": { "SearchTextAdditionalFeatureList$member": null } }, "SearchTextAdditionalFeatureList": { "base": null, "refs": { "SearchTextRequest$AdditionalFeatures": "A list of optional additional parameters, such as time zone, that can be requested for each result.
" } }, "SearchTextFilter": { "base": "SearchText structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
", "refs": { "SearchTextRequest$Filter": "A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" } }, "SearchTextIntendedUse": { "base": null, "refs": { "SearchTextRequest$IntendedUse": "Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Storing the response of an SearchText query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.
An optional limit for the number of results returned in a single call.
" } }, "SearchTextRequestQueryIdString": { "base": null, "refs": { "SearchTextRequest$QueryId": "The query Id returned by the suggest API. If passed in the request, the SearchText API will preform a SearchText query with the improved query terms for the original query made to the suggest API.
The fields QueryText, and QueryID are mutually exclusive.
The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.
The fields QueryText, and QueryID are mutually exclusive.
The text search result.
", "refs": { "SearchTextResultItemList$member": null } }, "SearchTextResultItemList": { "base": null, "refs": { "SearchTextResponse$ResultItems": "List of places or results returned for a query.
" } }, "SearchTextResultItemPlaceIdString": { "base": null, "refs": { "SearchTextResultItem$PlaceId": "The PlaceId of the place you wish to receive the information for.
The item's title.
" } }, "SecondaryAddressComponent": { "base": "Components that correspond to secondary identifiers on an address. The only component type supported currently is Unit.
", "refs": { "SecondaryAddressComponentList$member": null } }, "SecondaryAddressComponentList": { "base": null, "refs": { "Address$SecondaryAddressComponents": "Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor.
" } }, "SecondaryAddressComponentMatchScore": { "base": "Match score for a secondary address component in the result.
", "refs": { "SecondaryAddressComponentMatchScoreList$member": null } }, "SecondaryAddressComponentMatchScoreList": { "base": null, "refs": { "AddressComponentMatchScores$SecondaryAddressComponents": "Match scores for the secondary address components in the result.
" } }, "SecondaryAddressComponentNumberString": { "base": null, "refs": { "SecondaryAddressComponent$Number": "Number that uniquely identifies a secondary address.
" } }, "SensitiveBoolean": { "base": null, "refs": { "AccessRestriction$Restricted": "The restriction.
", "Category$Primary": "Boolean which indicates if this category is the primary offered by the place.
", "FoodType$Primary": "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.
", "GeocodeResultItem$AddressNumberCorrected": "Boolean indicating if the address provided has been corrected.
", "GetPlaceResponse$AddressNumberCorrected": "Boolean indicating if the address provided has been corrected.
", "OpeningHours$OpenNow": "Boolean which indicates if the result/place is currently open.
", "PhonemeTranscription$Preferred": "Boolean which indicates if it the preferred pronunciation.
", "ReverseGeocodeResultItem$AddressNumberCorrected": "Boolean indicating if the address provided has been corrected.
", "SearchNearbyResultItem$AddressNumberCorrected": "Boolean indicating if the address provided has been corrected.
", "SearchTextResultItem$AddressNumberCorrected": "Boolean indicating if the address provided has been corrected.
" } }, "StreetComponents": { "base": "Components of a street.
", "refs": { "StreetComponentsList$member": null } }, "StreetComponentsBaseNameString": { "base": null, "refs": { "StreetComponents$BaseName": "Base name part of the street name.
Example: Younge from the \"Younge street\".
" } }, "StreetComponentsDirectionString": { "base": null, "refs": { "StreetComponents$Direction": "Indicates the official directional identifiers assigned to highways.
" } }, "StreetComponentsList": { "base": null, "refs": { "Address$StreetComponents": "Components of the street.
Example: Younge from the \"Younge street\".
" } }, "StreetComponentsPrefixString": { "base": null, "refs": { "StreetComponents$Prefix": "A prefix is a directional identifier that precedes, but is not included in, the base name of a road.
Example: E for East.
" } }, "StreetComponentsSuffixString": { "base": null, "refs": { "StreetComponents$Suffix": "A suffix is a directional identifier that follows, but is not included in, the base name of a road.
Example W for West.
" } }, "StreetComponentsTypeString": { "base": null, "refs": { "StreetComponents$Type": "Street type part of the street name.
Example: \"avenue\".
The pricing bucket for which the query is charged at.
For more information on pricing, please visit Amazon Location Service Pricing.
", "GeocodeResponse$PricingBucket": "The pricing bucket for which the query is charged at.
For more information on pricing, please visit Amazon Location Service Pricing.
", "GetPlaceResponse$PricingBucket": "The pricing bucket for which the query is charged at.
For more information on pricing, please visit Amazon Location Service Pricing.
", "InternalServerException$Message": null, "ReverseGeocodeResponse$PricingBucket": "The pricing bucket for which the query is charged at.
For more information on pricing, please visit Amazon Location Service Pricing.
", "SearchNearbyResponse$PricingBucket": "The pricing bucket for which the query is charged at.
For more information on pricing, please visit Amazon Location Service Pricing.
", "SearchTextResponse$PricingBucket": "The pricing bucket for which the query is charged at.
For more information on pricing, please visit Amazon Location Service Pricing.
", "SuggestResponse$PricingBucket": "The pricing bucket for which the query is charged at.
For more information on pricing, please visit Amazon Location Service Pricing.
", "ThrottlingException$Message": null, "ValidationException$Message": null, "ValidationExceptionField$Name": "The name of the resource.
", "ValidationExceptionField$Message": "The error message.
" } }, "SubRegion": { "base": "The sub-region.
", "refs": { "Address$SubRegion": "The sub-region or county for which results should be present in.
" } }, "SubRegionCodeString": { "base": null, "refs": { "SubRegion$Code": "Abbreviated code for the county or sub-region.
" } }, "SubRegionHighlights": { "base": "Indicates the starting and ending index of the sub-region in the text query that match the found title.
", "refs": { "AutocompleteAddressHighlights$SubRegion": "The sub-region or county for which results should be present in.
" } }, "SubRegionNameString": { "base": null, "refs": { "SubRegion$Name": "Name for the county or sub-region.
" } }, "SuggestAdditionalFeature": { "base": null, "refs": { "SuggestAdditionalFeatureList$member": null } }, "SuggestAdditionalFeatureList": { "base": null, "refs": { "SuggestRequest$AdditionalFeatures": "A list of optional additional parameters, such as time zone, that can be requested for each result.
" } }, "SuggestAddressHighlights": { "base": "Describes how the parts of the textQuery matched the input query by returning the sections of the response which matched to textQuery terms.
", "refs": { "SuggestHighlights$Address": "The place's address.
" } }, "SuggestFilter": { "base": "SuggestFilter structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
", "refs": { "SuggestRequest$Filter": "A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" } }, "SuggestHighlights": { "base": "Describes how the parts of the textQuery matched the input query by returning the sections of the response which matched to textQuery terms.
", "refs": { "SuggestResultItem$Highlights": "Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.
" } }, "SuggestIntendedUse": { "base": null, "refs": { "SuggestRequest$IntendedUse": "Indicates if the results will be stored. Defaults to SingleUse, if left empty.
The suggested place results.
", "refs": { "SuggestResultItem$Place": "The suggested place by its unique ID.
" } }, "SuggestPlaceResultPlaceIdString": { "base": null, "refs": { "SuggestPlaceResult$PlaceId": "The PlaceId of the place you wish to receive the information for.
The suggested query results.
", "refs": { "SuggestResultItem$Query": null } }, "SuggestQueryResultQueryIdString": { "base": null, "refs": { "SuggestQueryResult$QueryId": "QueryId can be used to complete a follow up query through the SearchText API. The QueryId retains context from the original Suggest request such as filters, political view and language. See the SearchText API documentation for more details SearchText API docs.
The fields QueryText, and QueryID are mutually exclusive.
Maximum number of query terms to be returned for use with a search text query.
" } }, "SuggestRequestMaxResultsInteger": { "base": null, "refs": { "SuggestRequest$MaxResults": "An optional limit for the number of results returned in a single call.
" } }, "SuggestRequestQueryTextString": { "base": null, "refs": { "SuggestRequest$QueryText": "The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.
The fields QueryText, and QueryID are mutually exclusive.
The resulting item from the suggested query.
", "refs": { "SuggestResultItemList$member": null } }, "SuggestResultItemList": { "base": null, "refs": { "SuggestResponse$ResultItems": "List of places or results returned for a query.
" } }, "SuggestResultItemTitleString": { "base": null, "refs": { "SuggestResultItem$Title": "The display title that should be used when presenting this option to the end user.
" } }, "SuggestResultItemType": { "base": null, "refs": { "SuggestResultItem$SuggestResultItemType": "The result type. Place results represent the final result for a point of interest, Query results represent a follow up query which can be completed through the SearchText operation.
" } }, "ThrottlingException": { "base": "The request was denied due to request throttling.
", "refs": {} }, "TimeZone": { "base": "The time zone in which the place is located.
", "refs": { "GeocodeResultItem$TimeZone": "The time zone in which the place is located.
", "GetPlaceResponse$TimeZone": "The time zone in which the place is located.
", "ReverseGeocodeResultItem$TimeZone": "The time zone in which the place is located.
", "SearchNearbyResultItem$TimeZone": "The time zone in which the place is located.
", "SearchTextResultItem$TimeZone": "The time zone in which the place is located.
", "SuggestPlaceResult$TimeZone": "The time zone in which the place is located.
" } }, "TimeZoneNameString": { "base": null, "refs": { "TimeZone$Name": "The time zone name.
" } }, "TimeZoneOffsetSecondsLong": { "base": null, "refs": { "TimeZone$OffsetSeconds": "The offset of the time zone from UTC, in seconds.
" } }, "TimeZoneOffsetString": { "base": null, "refs": { "TimeZone$Offset": "Time zone offset of the timezone from UTC.
" } }, "Token": { "base": null, "refs": { "SearchNearbyRequest$NextToken": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.
Defines if the street type is before or after the base name.
" } }, "TypeSeparator": { "base": null, "refs": { "StreetComponents$TypeSeparator": "Defines a separator character such as \"\" or \" \" between the base name and type.
The USPS zip code.
", "refs": { "PostalCodeDetails$UspsZip": "The ZIP Classification Code, or in other words what type of postal code is it.
" } }, "UspsZipPlus4": { "base": "The USPS zip+4 code.
", "refs": { "PostalCodeDetails$UspsZipPlus4": "The USPS ZIP+4 Record Type Code.
" } }, "ValidationException": { "base": "The input fails to satisfy the constraints specified by an AWS service.
", "refs": {} }, "ValidationExceptionField": { "base": "The input fails to satisfy the constraints specified by the Amazon Location service.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$FieldList": "Test stub for FieldList.
" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$Reason": "Test stub for reason
" } }, "ZipClassificationCode": { "base": null, "refs": { "UspsZip$ZipClassificationCode": "The ZIP Classification Code, or in other words what type of postal code is it.
" } } } }