Top 50 cities list
Returns location data for the top 50 cities, worldwide
query Parameters
languagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usdetailsbooleanA boolean value that specifies whether or not to include extended information.
Default: falseformatstringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
PrimaryPostalCodestring · minLength: 1 · requiredOfficial postal code provided by our main location data provider for the requested location
RegionrequiredThe object containing the region details
TimeZonerequiredThe object containing the timezone details
GeoPositionrequiredThe 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[] · requiredThe object containing a list of administrative area details
DataSetsstring[] · requiredArray 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 · requiredLocation name as displayed in English
Versioninteger · int32 · requiredCurrent version of the API
Keystring · minLength: 1 · requiredUnique ID to search a location
Typestring · minLength: 1 · requiredLocation type such as City, PostalCode, POI or LatLong
Rankinteger · int32 · requiredNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedNamestring · minLength: 1 · requiredDisplay name in local dialect set with language code in URL. Default is US English (us-en)
CountryrequiredTHe object containing the country details
AdministrativeArearequiredThe object containing the amdministrative area details
ParentCity| nullThe 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| nullAccuWeather related details about the specific location
Top 100 cities list
Returns location data for the top 100 cities, worldwide
query Parameters
languagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usdetailsbooleanA boolean value that specifies whether or not to include extended information.
Default: falseformatstringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
PrimaryPostalCodestring · minLength: 1 · requiredOfficial postal code provided by our main location data provider for the requested location
RegionrequiredThe object containing the region details
TimeZonerequiredThe object containing the timezone details
GeoPositionrequiredThe 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[] · requiredThe object containing a list of administrative area details
DataSetsstring[] · requiredArray 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 · requiredLocation name as displayed in English
Versioninteger · int32 · requiredCurrent version of the API
Keystring · minLength: 1 · requiredUnique ID to search a location
Typestring · minLength: 1 · requiredLocation type such as City, PostalCode, POI or LatLong
Rankinteger · int32 · requiredNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedNamestring · minLength: 1 · requiredDisplay name in local dialect set with language code in URL. Default is US English (us-en)
CountryrequiredTHe object containing the country details
AdministrativeArearequiredThe object containing the amdministrative area details
ParentCity| nullThe 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| nullAccuWeather related details about the specific location
Top 150 cities list
Returns location data for the top 150 cities, worldwide
query Parameters
languagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usdetailsbooleanA boolean value that specifies whether or not to include extended information.
Default: falseformatstringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
PrimaryPostalCodestring · minLength: 1 · requiredOfficial postal code provided by our main location data provider for the requested location
RegionrequiredThe object containing the region details
TimeZonerequiredThe object containing the timezone details
GeoPositionrequiredThe 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[] · requiredThe object containing a list of administrative area details
DataSetsstring[] · requiredArray 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 · requiredLocation name as displayed in English
Versioninteger · int32 · requiredCurrent version of the API
Keystring · minLength: 1 · requiredUnique ID to search a location
Typestring · minLength: 1 · requiredLocation type such as City, PostalCode, POI or LatLong
Rankinteger · int32 · requiredNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedNamestring · minLength: 1 · requiredDisplay name in local dialect set with language code in URL. Default is US English (us-en)
CountryrequiredTHe object containing the country details
AdministrativeArearequiredThe object containing the amdministrative area details
ParentCity| nullThe 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| nullAccuWeather related details about the specific location
Top cities list by region
Returns location data for the top cities within a specific region
path Parameters
regionCodestringA unique ID that designates a specific region. More information can be found here.
Example: NAM
query Parameters
languageIDinteger · int32A unique ID that designates a specific language.
Default: 1detailsbooleanA boolean value that specifies whether or not to include extended information.
Default: false
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
PrimaryPostalCodestring · minLength: 1 · requiredOfficial postal code provided by our main location data provider for the requested location
RegionrequiredThe object containing the region details
TimeZonerequiredThe object containing the timezone details
GeoPositionrequiredThe 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[] · requiredThe object containing a list of administrative area details
DataSetsstring[] · requiredArray 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 · requiredLocation name as displayed in English
Versioninteger · int32 · requiredCurrent version of the API
Keystring · minLength: 1 · requiredUnique ID to search a location
Typestring · minLength: 1 · requiredLocation type such as City, PostalCode, POI or LatLong
Rankinteger · int32 · requiredNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedNamestring · minLength: 1 · requiredDisplay name in local dialect set with language code in URL. Default is US English (us-en)
CountryrequiredTHe object containing the country details
AdministrativeArearequiredThe object containing the amdministrative area details
ParentCity| nullThe 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| nullAccuWeather related details about the specific location
Countries list by region code
Specify a region code to return a list of countries within that region.
path Parameters
regionCodestringA unique ID that designates a specific region. More information can be found here.
Example: NAM
query Parameters
countryCodestringA unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: USlanguagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usoffsetinteger · int32A 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: -1formatstringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
IDstring · minLength: 1 · requiredUnique administrative area ID
LocalizedNamestring · minLength: 1 · requiredAdministrative 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 · requiredAdministrative area name displayed in English
Countries list
This endpoint returns a list of available countries.
query Parameters
regionCodestringA unique ID that designates a specific region. More information can be found here.
Example: NAMcountryCodestringA unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: USlanguagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usoffsetinteger · int32A 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: -1formatstringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
IDstring · minLength: 1 · requiredUnique administrative area ID
LocalizedNamestring · minLength: 1 · requiredAdministrative 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 · requiredAdministrative area name displayed in English
Region list
List of all available regions
query Parameters
regionCodestringA unique ID that designates a specific region. More information can be found here.
Example: NAMlanguagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usformatstringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
IDstring · minLength: 1 · requiredUnique administrative area ID
LocalizedNamestring · minLength: 1 · requiredAdministrative 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 · requiredAdministrative area name displayed in English
Country by region code and country code
Specify a region code and a country code to return basic information about a country.
path Parameters
query Parameters
languagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usformatstringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
IDstring · minLength: 1 · requiredUnique administrative area ID
LocalizedNamestring · minLength: 1 · requiredAdministrative 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 · requiredAdministrative area name displayed in English
Administrative area list by country code
Provide a country code to return basic information about administrative areas in the specified country
path Parameters
countryCodestringA unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: US
query Parameters
adminCodestringA unique ID that designates a specific administrative area. More information can be found here.
Example: NYlanguagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usoffsetinteger · int32A 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: -1formatstringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
Levelinteger · int64 · requiredAn 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 · requiredUnique ISO or Microsoft Localization Code for the country that contains the AdministrativeArea.
IDstring · minLength: 1 · requiredUnique administrative area ID
LocalizedNamestring · minLength: 1 · requiredAdministrative 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 · requiredAdministrative area name displayed in English
LocalizedTypestring | nullAdministrative Area type displayed in the local dialect set with the language code in the URL. Default is US English (en-us).
EnglishTypestring | nullAdministrative Area type displayed in English.
Administrative area list
Returns basic information about global administrative areas
query Parameters
countryCodestringA unique ISO or Microsoft Localization Code for a specific country. More information can be found here.
Example: USadminCodestringA unique ID that designates a specific administrative area. More information can be found here.
Example: NYlanguagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usoffsetinteger · int32A 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: -1formatstringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
Levelinteger · int64 · requiredAn 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 · requiredUnique ISO or Microsoft Localization Code for the country that contains the AdministrativeArea.
IDstring · minLength: 1 · requiredUnique administrative area ID
LocalizedNamestring · minLength: 1 · requiredAdministrative 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 · requiredAdministrative area name displayed in English
LocalizedTypestring | nullAdministrative Area type displayed in the local dialect set with the language code in the URL. Default is US English (en-us).
EnglishTypestring | nullAdministrative Area type displayed in English.