Core Weather

Text Search

Endpoint:https://dataservice.accuweather.com

City search by country code and administrative code

GET

https://dataservice.accuweather.com

/locations/v1/cities/{countryCode}/{adminCode}/search

Provide a country code, administrative code, and city name to search for a specific city.

City search by country code and administrative code › path Parameters

countryCodestring
A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US
adminCodestring
A unique ID that designates a specific administrative area. More information can be found here.
Example: NY

City search by country code and administrative code › query Parameters

qstring · required
A string that indicates a city name to search by.
Example: New York
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
offsetinteger · int32
A numerical value representing the first result to return. Results will be returned in sets of 25. Offset=0 will return the first 25 results, Offset=1 will return the second 25 results, etc.
Default: -1
alias
A numerical value indicating the mode of alias searching (0=Always, 1=Never, 2=No Official Match). No official match indicates an alias could be returned if no official location could be found.
Default: 2

City search by country code and administrative code › Headers

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

City search by country code and administrative code › 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

City search by country code

GET

https://dataservice.accuweather.com

/locations/v1/cities/{countryCode}/search

Provide a country code and city name to return location data

City search by country code › path Parameters

countryCodestring
A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US

City search by country code › query Parameters

qstring · required
A string that indicates a city name to search by.
Example: New York
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
offsetinteger · int32
A numerical value representing the first result to return. Results will be returned in sets of 25. Offset=0 will return the first 25 results, Offset=1 will return the second 25 results, etc.
Default: -1
adminCodestring
A unique ID that designates a specific administrative area. More information can be found here.
Example: NY
alias
A numerical value indicating the mode of alias searching (0=Always, 1=Never, 2=No Official Match). No official match indicates an alias could be returned if no official location could be found.
Default: 2

City search by country code › Headers

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

City search by country code › 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

City search

GET

https://dataservice.accuweather.com

/locations/v1/cities/search

Provide a city name to return location data.

City search › query Parameters

qstring · required
A string that indicates a city name to search by.
Example: New York
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
offsetinteger · int32
A numerical value representing the first result to return. Results will be returned in sets of 25. Offset=0 will return the first 25 results, Offset=1 will return the second 25 results, etc.
Default: -1
countryCodestring
A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US
adminCodestring
A unique ID that designates a specific administrative area. More information can be found here.
Example: NY
alias
A numerical value indicating the mode of alias searching (0=Always, 1=Never, 2=No Official Match). No official match indicates an alias could be returned if no official location could be found.
Default: 2

City search › Headers

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

City search › 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 country code and administrative code

GET

https://dataservice.accuweather.com

/locations/v1/{countryCode}/{adminCode}/search

Filter by country code and administrative code to return location data for a city, postal code or point of interest

Location search by country code and administrative code › path Parameters

countryCodestring
A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US
adminCodestring
A unique ID that designates a specific administrative area. More information can be found here.
Example: NY

Location search by country code and administrative code › query Parameters

qstring · required
A string that indicates a city name or point of interest to search by.
Example: New York
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
offsetinteger · int32
A numerical value representing the first result to return. Results will be returned in sets of 25. Offset=0 will return the first 25 results, Offset=1 will return the second 25 results, etc.
Default: -1
alias
A numerical value indicating the mode of alias searching (0=Always, 1=Never, 2=No Official Match). No official match indicates an alias could be returned if no official location could be found.
Default: 2

Location search by country code and administrative code › Headers

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

Location search by country code and administrative code › 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 country code

GET

https://dataservice.accuweather.com

/locations/v1/{countryCode}/search

Filter by country code to return location data for a city, postal code or point of interest

Location search by country code › path Parameters

countryCodestring
A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US

Location search by country code › query Parameters

qstring · required
A string that indicates a city name or point of interest to search by.
Example: New York
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
offsetinteger · int32
A numerical value representing the first result to return. Results will be returned in sets of 25. Offset=0 will return the first 25 results, Offset=1 will return the second 25 results, etc.
Default: -1
adminCodestring
A unique ID that designates a specific administrative area. More information can be found here.
Example: NY
alias
A numerical value indicating the mode of alias searching (0=Always, 1=Never, 2=No Official Match). No official match indicates an alias could be returned if no official location could be found.
Default: 2

Location search by country code › Headers

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

Location search by country code › 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

GET

https://dataservice.accuweather.com

/locations/v1/search

Specify a city name, postal code or point of interest to return location data.

Location search › query Parameters

qstring · required
A string that indicates a city name or point of interest to search by.
Example: New York
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
offsetinteger · int32
A numerical value representing the first result to return. Results will be returned in sets of 25. Offset=0 will return the first 25 results, Offset=1 will return the second 25 results, etc.
Default: -1
countryCodestring
A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US
adminCodestring
A unique ID that designates a specific administrative area. More information can be found here.
Example: NY
alias
A numerical value indicating the mode of alias searching (0=Always, 1=Never, 2=No Official Match). No official match indicates an alias could be returned if no official location could be found.
Default: 2

Location search › Headers

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

Location search › 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

Postal code search by country code

GET

https://dataservice.accuweather.com

/locations/v1/postalcodes/{countryCode}/search

Provide a country code and a postal code to search for a specific location.

Postal code search by country code › path Parameters

countryCodestring
A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US

Postal code search by country code › query Parameters

qstring · required
A string that indicates a postal code to search by.
Example: 07008
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

Postal code search by country code › Headers

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

Postal code search by country code › 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

Postal code search

GET

https://dataservice.accuweather.com

/locations/v1/postalcodes/search

Specify a postal code to search for a specific location.

Postal code search › query Parameters

qstring · required
A string that indicates a postal code to search by.
Example: 07008
countryCodestring
A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US
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

Postal code search › Headers

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

Postal code search › 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

Point of interest by country code and administrative code

GET

https://dataservice.accuweather.com

/locations/v1/poi/{countryCode}/{adminCode}/search

Filter by country code and administrative code to return location data for a point of interest.

A point of interest (POI) typically refers to a business location, tourist attraction, or other well-known site. Common examples include:

Airports
Stadiums
Parks

Point of interest by country code and administrative code › path Parameters

countryCodestring
A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US
adminCodestring
A unique ID that designates a specific administrative area. More information can be found here.
Example: NY

Point of interest by country code and administrative code › query Parameters

qstring · required
A string that indicates a point of interest to search by.
Example: New York
typestring
A string that indicates the type of POIs to include.
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
allLanguagesboolean
A boolean value that specifies whether or not to search translated locations.
Default: false

Point of interest by country code and administrative code › Headers

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

Point of interest by country code and administrative code › 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

Point of interest by country code

GET

https://dataservice.accuweather.com

/locations/v1/poi/{countryCode}/search

Filter by country code to return location data for a point of interest.

A point of interest (POI) typically refers to a business location, tourist attraction, or other well-known site. Common examples include:

Airports
Stadiums
Parks

Point of interest by country code › path Parameters

countryCodestring
A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US

Point of interest by country code › query Parameters

qstring · required
A string that indicates a point of interest to search by.
Example: New York
adminCodestring
A unique ID that designates a specific administrative area. More information can be found here.
Example: NY
typestring
A string that indicates the type of POIs to include.
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
allLanguagesboolean
A boolean value that specifies whether or not to search translated locations.
Default: false

Point of interest by country code › Headers

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

Point of interest by country code › 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

Point of interest search

GET

https://dataservice.accuweather.com

/locations/v1/poi/search

Specify a point of interest to return location data.

A point of interest (POI) typically refers to a business location, tourist attraction, or other well-known site. Common examples include:

Airports
Stadiums
Parks

Point of interest search › query Parameters

qstring · required
A string that indicates a point of interest to search by.
Example: New York
countryCodestring
A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US
adminCodestring
A unique ID that designates a specific administrative area. More information can be found here.
Example: NY
typestring
A string that indicates the type of POIs to include.
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
allLanguagesboolean
A boolean value that specifies whether or not to search translated locations.
Default: false

Point of interest search › Headers

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

Point of interest search › 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

Region search

GET

https://dataservice.accuweather.com

/locations/v1/regions/{regionCode}

Returns data about a specific region

Region search › path Parameters

regionCodestring
A unique ID that designates a specific region. More information can be found here.
Example: NAM

Region search › query Parameters

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

Region search › Headers

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

Region search › Responses

IDstring · minLength: 1 · required
Unique administrative area ID
LocalizedNamestring · minLength: 1 · required
Administrative area name as displayed in local dialect set with language code in the URL. If no language code is selected, the default is English
EnglishNamestring · minLength: 1 · required
Administrative area name displayed in English

Administrative area search by country code and text string

GET

https://dataservice.accuweather.com

/locations/v1/adminareas/{countryCode}/search

Search by country code and text string to return basic information about administrative areas. Use the q parameter to search for any administrative name.

Administrative area search by country code and text string › path Parameters

countryCodestring
A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US

Administrative area search by country code and text string › query Parameters

qstring
A string that indicates a free-form query to search.
Example: New York
adminCodestring
A unique ID that designates a specific administrative area. More information can be found here.
Example: NY
languagestring
A string that indicates the language in which to return the response. More information can be found here.
Default: en-us
offsetinteger · int32
A numerical value representing the first result to return. Results will be returned in sets of 25. Offset=0 will return the first 25 results, Offset=1 will return the second 25 results, etc.
Default: -1
formatstring
A string value that specifies what type of format to provide the response.
Default: json

Administrative area search by country code and text string › Headers

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

Administrative area search by country code and text string › Responses

Levelinteger · int64 · required
An assigned number to describe the scale of the administrative subdivisions for countries. As the Level number increases, the scale of the subdivision will decrease. Numbers of 10 or greater are reserved for non-political boundaries and should be used independently
CountryIDstring · minLength: 1 · required
Unique ISO or Microsoft Localization Code for the country that contains the AdministrativeArea.
IDstring · minLength: 1 · required
Unique administrative area ID
LocalizedNamestring · minLength: 1 · required
Administrative area name as displayed in local dialect set with language code in the URL. If no language code is selected, the default is English
EnglishNamestring · minLength: 1 · required
Administrative area name displayed in English

LocalizedTypestring | null
Administrative Area type displayed in the local dialect set with the language code in the URL. Default is US English (en-us).
EnglishTypestring | null
Administrative Area type displayed in English.

Administrative area search by text string

GET

https://dataservice.accuweather.com

/locations/v1/adminareas/search

Search by text string to return basic information about an administrative area. Use the q parameter to search for any administrative name.

Administrative area search by text string › query Parameters

qstring
A string that indicates a free-form query to search.
Example: New York
countryCodestring
A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US
adminCodestring
A unique ID that designates a specific administrative area. More information can be found here.
Example: NY
languagestring
A string that indicates the language in which to return the response. More information can be found here.
Default: en-us
offsetinteger · int32
A numerical value representing the first result to return. Results will be returned in sets of 25. Offset=0 will return the first 25 results, Offset=1 will return the second 25 results, etc.
Default: -1
formatstring
A string value that specifies what type of format to provide the response.
Default: json

Administrative area search by text string › Headers

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

Administrative area search by text string › Responses

Levelinteger · int64 · required
An assigned number to describe the scale of the administrative subdivisions for countries. As the Level number increases, the scale of the subdivision will decrease. Numbers of 10 or greater are reserved for non-political boundaries and should be used independently
CountryIDstring · minLength: 1 · required
Unique ISO or Microsoft Localization Code for the country that contains the AdministrativeArea.
IDstring · minLength: 1 · required
Unique administrative area ID
LocalizedNamestring · minLength: 1 · required
Administrative area name as displayed in local dialect set with language code in the URL. If no language code is selected, the default is English
EnglishNamestring · minLength: 1 · required
Administrative area name displayed in English

LocalizedTypestring | null
Administrative Area type displayed in the local dialect set with the language code in the URL. Default is US English (en-us).
EnglishTypestring | null
Administrative Area type displayed in English.

Administrative area search by country code and administrative area code

GET

https://dataservice.accuweather.com

/locations/v1/adminareas/{countryCode}/{adminCode}

Search by country code and administrative code to return basic information about administrative areas.

Administrative area search by country code and administrative area code › path Parameters

adminCodestring
A unique ID that designates a specific administrative area. More information can be found here.
Example: NY
countryCodestring
A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US

Administrative area search by country code and administrative area code › query Parameters

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

Administrative area search by country code and administrative area code › Headers

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

Administrative area search by country code and administrative area code › Responses

Levelinteger · int64 · required
An assigned number to describe the scale of the administrative subdivisions for countries. As the Level number increases, the scale of the subdivision will decrease. Numbers of 10 or greater are reserved for non-political boundaries and should be used independently
CountryIDstring · minLength: 1 · required
Unique ISO or Microsoft Localization Code for the country that contains the AdministrativeArea.
IDstring · minLength: 1 · required
Unique administrative area ID
LocalizedNamestring · minLength: 1 · required
Administrative area name as displayed in local dialect set with language code in the URL. If no language code is selected, the default is English
EnglishNamestring · minLength: 1 · required
Administrative area name displayed in English

LocalizedTypestring | null
Administrative Area type displayed in the local dialect set with the language code in the URL. Default is US English (en-us).
EnglishTypestring | null
Administrative Area type displayed in English.

Autocomplete Geoposition