Autocomplete by country code
Search for locations with a country code and an incomplete city name. Use the q
parameter to search any partial name.
path Parameters
countryCode
stringA unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US
query Parameters
q
string · requiredA string that indicates a partial city or point of interest name to search by.
Example: New Yorklanguage
stringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usincludeAliases
booleanA boolean indicating whether or not to include alias location results.
Default: falseformat
stringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate using your API key. Format isBearer YOUR_API_KEY
.
Responses
OK
Version
integer · int32 · requiredCurrent version of the API
Key
string · minLength: 1 · requiredUnique ID to search a location
Type
string · minLength: 1 · requiredLocation type such as City, PostalCode, POI or LatLong
Rank
integer · int32 · requiredNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedName
string · minLength: 1 · requiredDisplay name in local dialect set with language code in URL. Default is US English (us-en)
Country
requiredTHe object containing the country details
AdministrativeArea
requiredThe object containing the amdministrative area details
Autocomplete for cities and points of interest
Search for cities or points of interest around the world with an incomplete text string. Use the q
parameter to search any partial name.
The Autocomplete feature enhances the user experience by enabling intelligent and responsive location search capabilities:
- Fully supports all language localizations.
- Optimized for Latin-based languages to ensure the most accurate results.
- Returns the top 10 verified city results, ordered by relevance rank.
- Responses are truncated for Autocomplete queries to maintain speed and clarity.
query Parameters
q
string · requiredA string that indicates a partial city or point of interest name to search by.
Example: New Yorklanguage
stringA string that indicates the language in which to return the response. More information can be found here.
Default: en-uscountryCode
stringA unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: USincludeAliases
booleanA boolean indicating whether or not to include alias location results.
Default: falseformat
stringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate using your API key. Format isBearer YOUR_API_KEY
.
Responses
OK
Version
integer · int32 · requiredCurrent version of the API
Key
string · minLength: 1 · requiredUnique ID to search a location
Type
string · minLength: 1 · requiredLocation type such as City, PostalCode, POI or LatLong
Rank
integer · int32 · requiredNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedName
string · minLength: 1 · requiredDisplay name in local dialect set with language code in URL. Default is US English (us-en)
Country
requiredTHe object containing the country details
AdministrativeArea
requiredThe object containing the amdministrative area details
Autocomplete for points of interest by country code
Filter by country code and search for points of interest (POIs) using an incomplete text string. Use the q
parameter to search any partial name.
A point of interest (POI) typically refers to a business location, tourist attraction, or other well-known site. Common examples include:
- Airports
- Stadiums
- Parks
The Autocomplete feature enhances the user experience by enabling intelligent and responsive location search capabilities:
- Fully supports all language localizations.
- Optimized for Latin-based languages to ensure the most accurate results.
- Returns the top 10 verified city results, ordered by relevance rank.
- Responses are truncated for Autocomplete queries to maintain speed and clarity.
path Parameters
countryCode
stringA unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US
query Parameters
q
string · requiredA string that indicates a partial point of interest name to search by.
Example: New Yorklanguage
stringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usincludeAliases
booleanA boolean indicating whether or not to include alias location results.
Default: falseformat
stringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate using your API key. Format isBearer YOUR_API_KEY
.
Responses
OK
Version
integer · int32 · requiredCurrent version of the API
Key
string · minLength: 1 · requiredUnique ID to search a location
Type
string · minLength: 1 · requiredLocation type such as City, PostalCode, POI or LatLong
Rank
integer · int32 · requiredNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedName
string · minLength: 1 · requiredDisplay name in local dialect set with language code in URL. Default is US English (us-en)
Country
requiredTHe object containing the country details
AdministrativeArea
requiredThe object containing the amdministrative area details
Autocomplete for points of interest
Search for points of interest (POIs) using an incomplete text string. Use the q
parameter to search any partial name.
A point of interest (POI) typically refers to a business location, tourist attraction, or other well-known site. Common examples include:
- Airports
- Stadiums
- Parks
The Autocomplete feature enhances the user experience by enabling intelligent and responsive location search capabilities:
- Fully supports all language localizations.
- Optimized for Latin-based languages to ensure the most accurate results.
- Returns the top 10 verified city results, ordered by relevance rank.
- Responses are truncated for Autocomplete queries to maintain speed and clarity.
query Parameters
q
string · requiredA string that indicates a partial point of interest name to search by.
Example: New Yorklanguage
stringA string that indicates the language in which to return the response. More information can be found here.
Default: en-uscountryCode
stringA unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: USincludeAliases
booleanA boolean indicating whether or not to include alias location results.
Default: falseformat
stringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate using your API key. Format isBearer YOUR_API_KEY
.
Responses
OK
Version
integer · int32 · requiredCurrent version of the API
Key
string · minLength: 1 · requiredUnique ID to search a location
Type
string · minLength: 1 · requiredLocation type such as City, PostalCode, POI or LatLong
Rank
integer · int32 · requiredNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedName
string · minLength: 1 · requiredDisplay name in local dialect set with language code in URL. Default is US English (us-en)
Country
requiredTHe object containing the country details
AdministrativeArea
requiredThe object containing the amdministrative area details
Autocomplete for cities by country code
Specify a country code and search for cities around the world with a incomplete text string. Use the q
parameter to search any partial name.
The Autocomplete feature enhances the user experience by enabling intelligent and responsive location search capabilities:
- Fully supports all language localizations.
- Optimized for Latin-based languages to ensure the most accurate results.
- Returns the top 10 verified city results, ordered by relevance rank.
- Responses are truncated for Autocomplete queries to maintain speed and clarity.
path Parameters
countryCode
stringA unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US
query Parameters
q
string · requiredA string that indicates a partial city name to search by.
Example: New Yorklanguage
stringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usincludeAliases
booleanA boolean indicating whether or not to include alias location results.
Default: falseformat
stringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate using your API key. Format isBearer YOUR_API_KEY
.
Responses
OK
Version
integer · int32 · requiredCurrent version of the API
Key
string · minLength: 1 · requiredUnique ID to search a location
Type
string · minLength: 1 · requiredLocation type such as City, PostalCode, POI or LatLong
Rank
integer · int32 · requiredNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedName
string · minLength: 1 · requiredDisplay name in local dialect set with language code in URL. Default is US English (us-en)
Country
requiredTHe object containing the country details
AdministrativeArea
requiredThe object containing the amdministrative area details
Autocomplete for cities
Search for cities around the world with an incomplete text string. Use the q
parameter to search any partial name.
The Autocomplete feature enhances the user experience by enabling intelligent and responsive location search capabilities:
- Fully supports all language localizations.
- Optimized for Latin-based languages to ensure the most accurate results.
- Returns the top 10 verified city results, ordered by relevance rank.
- Responses are truncated for Autocomplete queries to maintain speed and clarity.
query Parameters
q
string · requiredA string that indicates a partial city name to search by.
Example: New Yorklanguage
stringA string that indicates the language in which to return the response. More information can be found here.
Default: en-uscountryCode
stringA unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: USincludeAliases
booleanA boolean indicating whether or not to include alias location results.
Default: falseformat
stringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate using your API key. Format isBearer YOUR_API_KEY
.
Responses
OK
Version
integer · int32 · requiredCurrent version of the API
Key
string · minLength: 1 · requiredUnique ID to search a location
Type
string · minLength: 1 · requiredLocation type such as City, PostalCode, POI or LatLong
Rank
integer · int32 · requiredNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedName
string · minLength: 1 · requiredDisplay name in local dialect set with language code in URL. Default is US English (us-en)
Country
requiredTHe object containing the country details
AdministrativeArea
requiredThe object containing the amdministrative area details