Neighboring location data by location key
Specify a location key to return location data about all neighboring locations.
path Parameters
locationKeyA unique ID that designates a specific location. More information can be found here.
query Parameters
languageA string that indicates the language in which to return the response. More information can be found here.
detailsA boolean value that specifies whether or not to include extended information.
formatA string value that specifies what type of format to provide the response.
Headers
AuthorizationThe Authorization header is used to authenticate using your API key. Format is Bearer YOUR_API_KEY.
Neighboring location data by location key › Responses
OK
PrimaryPostalCodeOfficial postal code provided by our main location data provider for the requested location
IsAlias“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location
The object containing a list of administrative area details
DataSetsArray of location-specific products that are available for this location. Products include Alerts, PremiumAirQuality, AirQuality, MinuteCast, and ForecastConfidence. If no location-specific products are available, the array will be empty.
EnglishNameLocation name as displayed in English
VersionCurrent version of the API
KeyUnique ID to search a location
TypeLocation type such as City, PostalCode, POI or LatLong
RankNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedNameDisplay name in local dialect set with language code in URL. Default is US English (us-en)
Location search by location key
Specify a location key to return location data.
path Parameters
locationKeyA unique ID that designates a specific location. More information can be found here.
query Parameters
languageA string that indicates the language in which to return the response. More information can be found here.
detailsA boolean value that specifies whether or not to include extended information.
formatA string value that specifies what type of format to provide the response.
Headers
AuthorizationThe Authorization header is used to authenticate using your API key. Format is Bearer YOUR_API_KEY.
Location search by location key › Responses
OK
PrimaryPostalCodeOfficial postal code provided by our main location data provider for the requested location
IsAlias“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location
The object containing a list of administrative area details
DataSetsArray of location-specific products that are available for this location. Products include Alerts, PremiumAirQuality, AirQuality, MinuteCast, and ForecastConfidence. If no location-specific products are available, the array will be empty.
EnglishNameLocation name as displayed in English
VersionCurrent version of the API
KeyUnique ID to search a location
TypeLocation type such as City, PostalCode, POI or LatLong
RankNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedNameDisplay name in local dialect set with language code in URL. Default is US English (us-en)