Core Weather

Location Key

Endpoint:https://dataservice.accuweather.com

Neighboring location data by location key

GET

https://dataservice.accuweather.com

/locations/v1/cities/neighbors/{locationKey}

Specify a location key to return location data about all neighboring locations.

Neighboring location data by location key › path Parameters

locationKeyinteger · int32 · required
A unique ID that designates a specific location. More information can be found here.
Example: 349727

Neighboring location data by location key › query Parameters

languagestring
A string that indicates the language in which to return the response. More information can be found here.
Default: en-us
detailsboolean
A boolean value that specifies whether or not to include extended information.
Default: false
formatstring
A string value that specifies what type of format to provide the response.
Default: json

Neighboring location data by location key › Headers

Authorizationstring · required
The Authorization header is used to authenticate using your API key. Format is Bearer YOUR_API_KEY.

Neighboring location data by location key › Responses

PrimaryPostalCodestring · minLength: 1 · required
Official postal code provided by our main location data provider for the requested location
Regionrequired
The object containing the region details
TimeZonerequired
The object containing the timezone details
GeoPositionrequired
The object containing the geoposition details
IsAliasboolean · required
“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location
SupplementalAdminAreasobject[] · required
The object containing a list of administrative area details
DataSetsstring[] · required
Array 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.
EnglishNamestring · minLength: 1 · required
Location name as displayed in English
Versioninteger · int32 · required
Current version of the API
Keystring · minLength: 1 · required
Unique ID to search a location
Typestring · minLength: 1 · required
Location type such as City, PostalCode, POI or LatLong
Rankinteger · int32 · required
Number applied to locations set by factors such as population, political importance, and geographic size
LocalizedNamestring · minLength: 1 · required
Display name in local dialect set with language code in URL. Default is US English (us-en)
Countryrequired
THe object containing the country details
AdministrativeArearequired
The object containing the amdministrative area details

ParentCity | null
The object containing the parentcity details. This object will be displayed only if the location is part of a larger metropolitan area or parent city.
Details | null
AccuWeather related details about the specific location

Location search by location key

GET

https://dataservice.accuweather.com

/locations/v1/{locationKey}

Specify a location key to return location data.

Location search by location key › path Parameters

locationKeystring · required
A unique ID that designates a specific location. More information can be found here.
Example: 349727

Location search by location key › query Parameters

languagestring
A string that indicates the language in which to return the response. More information can be found here.
Default: en-us
detailsboolean
A boolean value that specifies whether or not to include extended information.
Default: false
formatstring
A string value that specifies what type of format to provide the response.
Default: json

Location search by location key › Headers

Authorizationstring · required
The Authorization header is used to authenticate using your API key. Format is Bearer YOUR_API_KEY.

Location search by location key › Responses

PrimaryPostalCodestring · minLength: 1 · required
Official postal code provided by our main location data provider for the requested location
Regionrequired
The object containing the region details
TimeZonerequired
The object containing the timezone details
GeoPositionrequired
The object containing the geoposition details
IsAliasboolean · required
“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location
SupplementalAdminAreasobject[] · required
The object containing a list of administrative area details
DataSetsstring[] · required
Array 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.
EnglishNamestring · minLength: 1 · required
Location name as displayed in English
Versioninteger · int32 · required
Current version of the API
Keystring · minLength: 1 · required
Unique ID to search a location
Typestring · minLength: 1 · required
Location type such as City, PostalCode, POI or LatLong
Rankinteger · int32 · required
Number applied to locations set by factors such as population, political importance, and geographic size
LocalizedNamestring · minLength: 1 · required
Display name in local dialect set with language code in URL. Default is US English (us-en)
Countryrequired
THe object containing the country details
AdministrativeArearequired
The object containing the amdministrative area details

ParentCity | null
The object containing the parentcity details. This object will be displayed only if the location is part of a larger metropolitan area or parent city.
Details | null
AccuWeather related details about the specific location

Location Key List