List

PrimaryPostalCode

string · minLength: 1 · required

Official postal code provided by our main location data provider for the requested location

required

The object containing the region details

required

The object containing the timezone details

required

The object containing the geoposition details

IsAlias

boolean · required

“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location

API.Locations.Entities.OpenAPI.SupplementalAdminArea[] · required

The object containing a list of administrative area details

DataSets

string[] · 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.

EnglishName

string · minLength: 1 · required

Location name as displayed in English

Version

integer · int32 · required

Current version of the API

Key

string · minLength: 1 · required

Unique ID to search a location

Type

string · minLength: 1 · required

Location type such as City, PostalCode, POI or LatLong

Rank

integer · int32 · required

Number applied to locations set by factors such as population, political importance, and geographic size

LocalizedName

string · minLength: 1 · required

Display name in local dialect set with language code in URL. Default is US English (us-en)

required

THe object containing the country details

required

The object containing the amdministrative area details

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.

AccuWeather related details about the specific location

GET/locations/v1/topcities/50

curl https://dataservice.accuweather.com/locations/v1/topcities/50 \
  --header 'Authorization: <api-key>'

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {},
    "TimeZone": {},
    "GeoPosition": {},
    "IsAlias": true,
    "ParentCity": {},
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {},
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {},
    "AdministrativeArea": {}
  }
]

json

application/json

Top 100 cities list

GET

https://dataservice.accuweather.com

/locations/v1/topcities/100

Returns location data for the top 100 cities, worldwide

Top 100 cities list › query Parameters

language

string

A string that indicates the language in which to return the response. More information can be found here.

Default: en-us

details

boolean

A boolean value that specifies whether or not to include extended information.

Default: false

format

string

A string value that specifies what type of format to provide the response.

Default: json

Top 100 cities list › Headers

Authorization

string · required

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

Top 100 cities list › Responses

PrimaryPostalCode

string · minLength: 1 · required

Official postal code provided by our main location data provider for the requested location

required

The object containing the region details

required

The object containing the timezone details

required

The object containing the geoposition details

IsAlias

boolean · required

“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location

API.Locations.Entities.OpenAPI.SupplementalAdminArea[] · required

The object containing a list of administrative area details

DataSets

string[] · required

EnglishName

string · minLength: 1 · required

Location name as displayed in English

Version

integer · int32 · required

Current version of the API

Key

string · minLength: 1 · required

Unique ID to search a location

Type

string · minLength: 1 · required

Location type such as City, PostalCode, POI or LatLong

Rank

integer · int32 · required

Number applied to locations set by factors such as population, political importance, and geographic size

LocalizedName

string · minLength: 1 · required

Display name in local dialect set with language code in URL. Default is US English (us-en)

required

THe object containing the country details

required

The object containing the amdministrative area details

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.

AccuWeather related details about the specific location

GET/locations/v1/topcities/100

curl https://dataservice.accuweather.com/locations/v1/topcities/100 \
  --header 'Authorization: <api-key>'

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {},
    "TimeZone": {},
    "GeoPosition": {},
    "IsAlias": true,
    "ParentCity": {},
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {},
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {},
    "AdministrativeArea": {}
  }
]

json

application/json

Top 150 cities list

GET

https://dataservice.accuweather.com

/locations/v1/topcities/150

Returns location data for the top 150 cities, worldwide

Top 150 cities list › query Parameters

language

string

A string that indicates the language in which to return the response. More information can be found here.

Default: en-us

details

boolean

A boolean value that specifies whether or not to include extended information.

Default: false

format

string

A string value that specifies what type of format to provide the response.

Default: json

Top 150 cities list › Headers

Authorization

string · required

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

Top 150 cities list › Responses

PrimaryPostalCode

string · minLength: 1 · required

Official postal code provided by our main location data provider for the requested location

required

The object containing the region details

required

The object containing the timezone details

required

The object containing the geoposition details

IsAlias

boolean · required

“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location

API.Locations.Entities.OpenAPI.SupplementalAdminArea[] · required

The object containing a list of administrative area details

DataSets

string[] · required

EnglishName

string · minLength: 1 · required

Location name as displayed in English

Version

integer · int32 · required

Current version of the API

Key

string · minLength: 1 · required

Unique ID to search a location

Type

string · minLength: 1 · required

Location type such as City, PostalCode, POI or LatLong

Rank

integer · int32 · required

Number applied to locations set by factors such as population, political importance, and geographic size

LocalizedName

string · minLength: 1 · required

Display name in local dialect set with language code in URL. Default is US English (us-en)

required

THe object containing the country details

required

The object containing the amdministrative area details

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.

AccuWeather related details about the specific location

GET/locations/v1/topcities/150

curl https://dataservice.accuweather.com/locations/v1/topcities/150 \
  --header 'Authorization: <api-key>'

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {},
    "TimeZone": {},
    "GeoPosition": {},
    "IsAlias": true,
    "ParentCity": {},
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {},
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {},
    "AdministrativeArea": {}
  }
]

json

application/json

Top cities list by region

GET

https://dataservice.accuweather.com

/locations/v1/topcities/regions/{regionCode}

Returns location data for the top cities within a specific region

Top cities list by region › path Parameters

regionCode

string

A unique ID that designates a specific region. More information can be found here.

Example: NAM

Top cities list by region › query Parameters

languageID

integer · int32

A unique ID that designates a specific language.

Default: 1

details

boolean

A boolean value that specifies whether or not to include extended information.

Default: false

Top cities list by region › Headers

Authorization

string · required

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

Top cities list by region › Responses

API.Locations.Entities.OpenAPI.Area[]

PrimaryPostalCode

string · minLength: 1 · required

Official postal code provided by our main location data provider for the requested location

required

The object containing the region details

required

The object containing the timezone details

required

The object containing the geoposition details

IsAlias

boolean · required

“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location

API.Locations.Entities.OpenAPI.SupplementalAdminArea[] · required

The object containing a list of administrative area details

DataSets

string[] · required

EnglishName

string · minLength: 1 · required

Location name as displayed in English

Version

integer · int32 · required

Current version of the API

Key

string · minLength: 1 · required

Unique ID to search a location

Type

string · minLength: 1 · required

Location type such as City, PostalCode, POI or LatLong

Rank

integer · int32 · required

Number applied to locations set by factors such as population, political importance, and geographic size

LocalizedName

string · minLength: 1 · required

Display name in local dialect set with language code in URL. Default is US English (us-en)

required

THe object containing the country details

required

The object containing the amdministrative area details

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.

AccuWeather related details about the specific location

GET/locations/v1/topcities/regions/{regionCode}

curl https://dataservice.accuweather.com/locations/v1/topcities/regions/:regionCode \
  --header 'Authorization: <api-key>'

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {},
    "TimeZone": {},
    "GeoPosition": {},
    "IsAlias": true,
    "ParentCity": {},
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {},
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {},
    "AdministrativeArea": {}
  }
]

json

application/json

Countries list by region code

GET

https://dataservice.accuweather.com

/locations/v1/countries/{regionCode}

Specify a region code to return a list of countries within that region.

Countries list by region code › path Parameters

regionCode

string

A unique ID that designates a specific region. More information can be found here.

Example: NAM

Countries list by region code › query Parameters

countryCode

string

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

Example: US

language

string

A string that indicates the language in which to return the response. More information can be found here.

Default: en-us

offset

integer · 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

format

string

A string value that specifies what type of format to provide the response.

Default: json

Countries list by region code › Headers

Authorization

string · required

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

Countries list by region code › Responses

API.Locations.Entities.OpenAPI.Area[]

ID

string · minLength: 1 · required

Unique administrative area ID

LocalizedName

string · 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

EnglishName

string · minLength: 1 · required

Administrative area name displayed in English

Countries list

GET

https://dataservice.accuweather.com

/locations/v1/countries

This endpoint returns a list of available countries.

Countries list › query Parameters

regionCode

string

A unique ID that designates a specific region. More information can be found here.

Example: NAM

countryCode

string

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

Example: US

language

string

A string that indicates the language in which to return the response. More information can be found here.

Default: en-us

offset

integer · 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

format

string

A string value that specifies what type of format to provide the response.

Default: json

Countries list › Headers

Authorization

string · required

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

Countries list › Responses

API.Locations.Entities.OpenAPI.Area[]

ID

string · minLength: 1 · required

Unique administrative area ID

LocalizedName

string · 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

EnglishName

string · minLength: 1 · required

Administrative area name displayed in English

Region list

GET

https://dataservice.accuweather.com

/locations/v1/regions

List of all available regions

Region list › query Parameters

regionCode

string

A unique ID that designates a specific region. More information can be found here.

Example: NAM

language

string

A string that indicates the language in which to return the response. More information can be found here.

Default: en-us

format

string

A string value that specifies what type of format to provide the response.

Default: json

Region list › Headers

Authorization

string · required

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

Region list › Responses

ID

string · minLength: 1 · required

Unique administrative area ID

LocalizedName

string · 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

EnglishName

string · minLength: 1 · required

Administrative area name displayed in English

Country by region code and country code

GET

https://dataservice.accuweather.com

/locations/v1/countries/{regionCode}/{countryCode}

Specify a region code and a country code to return basic information about a country.

Country by region code and country code › path Parameters

regionCode

string · required

A unique ID that designates a specific region. More information can be found here.

countryCode

string · required

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

Country by region code and country code › query Parameters

language

string

A string that indicates the language in which to return the response. More information can be found here.

Default: en-us

format

string

A string value that specifies what type of format to provide the response.

Default: json

Country by region code and country code › Headers

Authorization

string · required

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

Country by region code and country code › Responses