Core Weather

Text Search

Endpointhttps://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

countryCode

string

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

Example: US

adminCode

string

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

q

string · required

A string that indicates a city name to search by.

Example: New York

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

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

alias

integer · enum · int32

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.

Enum values:

Default: 2

City search by country code and administrative code › Headers

Authorization

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

object[]

PrimaryPostalCode

string · minLength: 1 · required

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

object · required

IsAlias

boolean · required

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

object[] · 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)

object · required

object

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

curl --request GET \
  --url 'https://dataservice.accuweather.com/locations/v1/cities/:countryCode/:adminCode/search?q=%3Cstring%3E' \
  --header 'Authorization: Bearer YOUR_API_KEY'

shell

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "TimeZone": {
      "Code": "Code",
      "NextOffsetChange": "2024-08-25T15:00:00Z",
      "Name": "Name",
      "GmtOffset": 0,
      "IsDaylightSaving": true
    },
    "GeoPosition": {
      "Elevation": {
        "Metric": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        },
        "Imperial": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        }
      },
      "Latitude": 0,
      "Longitude": 0
    },
    "IsAlias": true,
    "ParentCity": {
      "Key": "Key",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {
      "Key": "Key",
      "StationCode": "StationCode",
      "StationGmtOffset": 0,
      "BandMap": "BandMap",
      "Climo": "Climo",
      "LocalRadar": "LocalRadar",
      "MediaRegion": "MediaRegion",
      "Metar": "Metar",
      "NXMetro": "NXMetro",
      "NXState": "NXState",
      "Population": 0,
      "PrimaryWarningCountyCode": "PrimaryWarningCountyCode",
      "PrimaryWarningZoneCode": "PrimaryWarningZoneCode",
      "Satellite": "Satellite",
      "Synoptic": "Synoptic",
      "MarineStation": "MarineStation",
      "MarineStationGMTOffset": 0,
      "VideoCode": "VideoCode",
      "LocationStem": "LocationStem",
      "DMA": {
        "ID": "ID",
        "EnglishName": "EnglishName"
      },
      "PartnerID": {},
      "Sources": [
        {
          "DataType": "DataType",
          "Source": "Source",
          "SourceId": 0,
          "PartnerSourceUrl": {}
        }
      ],
      "CanonicalPostalCode": "CanonicalPostalCode",
      "CanonicalLocationKey": "CanonicalLocationKey"
    },
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "AdministrativeArea": {
      "Level": 0,
      "LocalizedType": {},
      "EnglishType": {},
      "CountryID": "CountryID",
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    }
  }
]

json

application/json

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

countryCode

string

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

q

string · required

A string that indicates a city name to search by.

Example: New York

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

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

adminCode

string

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

Example: NY

alias

integer · enum · int32

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.

Enum values:

Default: 2

City search by country code › Headers

Authorization

string · required

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

City search by country code › Responses

object[]

PrimaryPostalCode

string · minLength: 1 · required

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

object · required

IsAlias

boolean · required

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

object[] · 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)

object · required

object

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

curl --request GET \
  --url 'https://dataservice.accuweather.com/locations/v1/cities/:countryCode/search?q=%3Cstring%3E' \
  --header 'Authorization: Bearer YOUR_API_KEY'

shell

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "TimeZone": {
      "Code": "Code",
      "NextOffsetChange": "2024-08-25T15:00:00Z",
      "Name": "Name",
      "GmtOffset": 0,
      "IsDaylightSaving": true
    },
    "GeoPosition": {
      "Elevation": {
        "Metric": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        },
        "Imperial": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        }
      },
      "Latitude": 0,
      "Longitude": 0
    },
    "IsAlias": true,
    "ParentCity": {
      "Key": "Key",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {
      "Key": "Key",
      "StationCode": "StationCode",
      "StationGmtOffset": 0,
      "BandMap": "BandMap",
      "Climo": "Climo",
      "LocalRadar": "LocalRadar",
      "MediaRegion": "MediaRegion",
      "Metar": "Metar",
      "NXMetro": "NXMetro",
      "NXState": "NXState",
      "Population": 0,
      "PrimaryWarningCountyCode": "PrimaryWarningCountyCode",
      "PrimaryWarningZoneCode": "PrimaryWarningZoneCode",
      "Satellite": "Satellite",
      "Synoptic": "Synoptic",
      "MarineStation": "MarineStation",
      "MarineStationGMTOffset": 0,
      "VideoCode": "VideoCode",
      "LocationStem": "LocationStem",
      "DMA": {
        "ID": "ID",
        "EnglishName": "EnglishName"
      },
      "PartnerID": {},
      "Sources": [
        {
          "DataType": "DataType",
          "Source": "Source",
          "SourceId": 0,
          "PartnerSourceUrl": {}
        }
      ],
      "CanonicalPostalCode": "CanonicalPostalCode",
      "CanonicalLocationKey": "CanonicalLocationKey"
    },
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "AdministrativeArea": {
      "Level": 0,
      "LocalizedType": {},
      "EnglishType": {},
      "CountryID": "CountryID",
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    }
  }
]

json

application/json

City search

GET

https://dataservice.accuweather.com

/locations/v1/cities/search

Provide a city name to return location data.

City search › query Parameters

q

string · required

A string that indicates a city name to search by.

Example: New York

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

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

countryCode

string

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

Example: US

adminCode

string

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

Example: NY

alias

integer · enum · int32

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.

Enum values:

Default: 2

City search › Headers

Authorization

string · required

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

City search › Responses

object[]

PrimaryPostalCode

string · minLength: 1 · required

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

object · required

IsAlias

boolean · required

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

object[] · 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)

object · required

object

GET/locations/v1/cities/search

curl --request GET \
  --url 'https://dataservice.accuweather.com/locations/v1/cities/search?q=%3Cstring%3E' \
  --header 'Authorization: Bearer YOUR_API_KEY'

shell

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "TimeZone": {
      "Code": "Code",
      "NextOffsetChange": "2024-08-25T15:00:00Z",
      "Name": "Name",
      "GmtOffset": 0,
      "IsDaylightSaving": true
    },
    "GeoPosition": {
      "Elevation": {
        "Metric": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        },
        "Imperial": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        }
      },
      "Latitude": 0,
      "Longitude": 0
    },
    "IsAlias": true,
    "ParentCity": {
      "Key": "Key",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {
      "Key": "Key",
      "StationCode": "StationCode",
      "StationGmtOffset": 0,
      "BandMap": "BandMap",
      "Climo": "Climo",
      "LocalRadar": "LocalRadar",
      "MediaRegion": "MediaRegion",
      "Metar": "Metar",
      "NXMetro": "NXMetro",
      "NXState": "NXState",
      "Population": 0,
      "PrimaryWarningCountyCode": "PrimaryWarningCountyCode",
      "PrimaryWarningZoneCode": "PrimaryWarningZoneCode",
      "Satellite": "Satellite",
      "Synoptic": "Synoptic",
      "MarineStation": "MarineStation",
      "MarineStationGMTOffset": 0,
      "VideoCode": "VideoCode",
      "LocationStem": "LocationStem",
      "DMA": {
        "ID": "ID",
        "EnglishName": "EnglishName"
      },
      "PartnerID": {},
      "Sources": [
        {
          "DataType": "DataType",
          "Source": "Source",
          "SourceId": 0,
          "PartnerSourceUrl": {}
        }
      ],
      "CanonicalPostalCode": "CanonicalPostalCode",
      "CanonicalLocationKey": "CanonicalLocationKey"
    },
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "AdministrativeArea": {
      "Level": 0,
      "LocalizedType": {},
      "EnglishType": {},
      "CountryID": "CountryID",
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    }
  }
]

json

application/json

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

countryCode

string

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

Example: US

adminCode

string

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

q

string · required

A string that indicates a city name or point of interest to search by.

Example: New York

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

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

alias

integer · enum · int32

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.

Enum values:

Default: 2

Location search by country code and administrative code › Headers

Authorization

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

object[]

PrimaryPostalCode

string · minLength: 1 · required

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

object · required

IsAlias

boolean · required

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

object[] · 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)

object · required

object

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

curl --request GET \
  --url 'https://dataservice.accuweather.com/locations/v1/:countryCode/:adminCode/search?q=%3Cstring%3E' \
  --header 'Authorization: Bearer YOUR_API_KEY'

shell

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "TimeZone": {
      "Code": "Code",
      "NextOffsetChange": "2024-08-25T15:00:00Z",
      "Name": "Name",
      "GmtOffset": 0,
      "IsDaylightSaving": true
    },
    "GeoPosition": {
      "Elevation": {
        "Metric": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        },
        "Imperial": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        }
      },
      "Latitude": 0,
      "Longitude": 0
    },
    "IsAlias": true,
    "ParentCity": {
      "Key": "Key",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {
      "Key": "Key",
      "StationCode": "StationCode",
      "StationGmtOffset": 0,
      "BandMap": "BandMap",
      "Climo": "Climo",
      "LocalRadar": "LocalRadar",
      "MediaRegion": "MediaRegion",
      "Metar": "Metar",
      "NXMetro": "NXMetro",
      "NXState": "NXState",
      "Population": 0,
      "PrimaryWarningCountyCode": "PrimaryWarningCountyCode",
      "PrimaryWarningZoneCode": "PrimaryWarningZoneCode",
      "Satellite": "Satellite",
      "Synoptic": "Synoptic",
      "MarineStation": "MarineStation",
      "MarineStationGMTOffset": 0,
      "VideoCode": "VideoCode",
      "LocationStem": "LocationStem",
      "DMA": {
        "ID": "ID",
        "EnglishName": "EnglishName"
      },
      "PartnerID": {},
      "Sources": [
        {
          "DataType": "DataType",
          "Source": "Source",
          "SourceId": 0,
          "PartnerSourceUrl": {}
        }
      ],
      "CanonicalPostalCode": "CanonicalPostalCode",
      "CanonicalLocationKey": "CanonicalLocationKey"
    },
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "AdministrativeArea": {
      "Level": 0,
      "LocalizedType": {},
      "EnglishType": {},
      "CountryID": "CountryID",
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    }
  }
]

json

application/json

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

countryCode

string

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

q

string · required

A string that indicates a city name or point of interest to search by.

Example: New York

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

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

adminCode

string

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

Example: NY

alias

integer · enum · int32

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.

Enum values:

Default: 2

Location search by country code › Headers

Authorization

string · required

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

Location search by country code › Responses

object[]

PrimaryPostalCode

string · minLength: 1 · required

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

object · required

IsAlias

boolean · required

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

object[] · 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)

object · required

object

GET/locations/v1/{countryCode}/search

curl --request GET \
  --url 'https://dataservice.accuweather.com/locations/v1/:countryCode/search?q=%3Cstring%3E' \
  --header 'Authorization: Bearer YOUR_API_KEY'

shell

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "TimeZone": {
      "Code": "Code",
      "NextOffsetChange": "2024-08-25T15:00:00Z",
      "Name": "Name",
      "GmtOffset": 0,
      "IsDaylightSaving": true
    },
    "GeoPosition": {
      "Elevation": {
        "Metric": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        },
        "Imperial": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        }
      },
      "Latitude": 0,
      "Longitude": 0
    },
    "IsAlias": true,
    "ParentCity": {
      "Key": "Key",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {
      "Key": "Key",
      "StationCode": "StationCode",
      "StationGmtOffset": 0,
      "BandMap": "BandMap",
      "Climo": "Climo",
      "LocalRadar": "LocalRadar",
      "MediaRegion": "MediaRegion",
      "Metar": "Metar",
      "NXMetro": "NXMetro",
      "NXState": "NXState",
      "Population": 0,
      "PrimaryWarningCountyCode": "PrimaryWarningCountyCode",
      "PrimaryWarningZoneCode": "PrimaryWarningZoneCode",
      "Satellite": "Satellite",
      "Synoptic": "Synoptic",
      "MarineStation": "MarineStation",
      "MarineStationGMTOffset": 0,
      "VideoCode": "VideoCode",
      "LocationStem": "LocationStem",
      "DMA": {
        "ID": "ID",
        "EnglishName": "EnglishName"
      },
      "PartnerID": {},
      "Sources": [
        {
          "DataType": "DataType",
          "Source": "Source",
          "SourceId": 0,
          "PartnerSourceUrl": {}
        }
      ],
      "CanonicalPostalCode": "CanonicalPostalCode",
      "CanonicalLocationKey": "CanonicalLocationKey"
    },
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "AdministrativeArea": {
      "Level": 0,
      "LocalizedType": {},
      "EnglishType": {},
      "CountryID": "CountryID",
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    }
  }
]

json

application/json

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

q

string · required

A string that indicates a city name or point of interest to search by.

Example: New York

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

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

countryCode

string

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

Example: US

adminCode

string

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

Example: NY

alias

integer · enum · int32

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.

Enum values:

Default: 2

Location search › Headers

Authorization

string · required

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

Location search › Responses

object[]

PrimaryPostalCode

string · minLength: 1 · required

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

object · required

IsAlias

boolean · required

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

object[] · 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)

object · required

object

GET/locations/v1/search

curl --request GET \
  --url 'https://dataservice.accuweather.com/locations/v1/search?q=%3Cstring%3E' \
  --header 'Authorization: Bearer YOUR_API_KEY'

shell

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "TimeZone": {
      "Code": "Code",
      "NextOffsetChange": "2024-08-25T15:00:00Z",
      "Name": "Name",
      "GmtOffset": 0,
      "IsDaylightSaving": true
    },
    "GeoPosition": {
      "Elevation": {
        "Metric": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        },
        "Imperial": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        }
      },
      "Latitude": 0,
      "Longitude": 0
    },
    "IsAlias": true,
    "ParentCity": {
      "Key": "Key",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {
      "Key": "Key",
      "StationCode": "StationCode",
      "StationGmtOffset": 0,
      "BandMap": "BandMap",
      "Climo": "Climo",
      "LocalRadar": "LocalRadar",
      "MediaRegion": "MediaRegion",
      "Metar": "Metar",
      "NXMetro": "NXMetro",
      "NXState": "NXState",
      "Population": 0,
      "PrimaryWarningCountyCode": "PrimaryWarningCountyCode",
      "PrimaryWarningZoneCode": "PrimaryWarningZoneCode",
      "Satellite": "Satellite",
      "Synoptic": "Synoptic",
      "MarineStation": "MarineStation",
      "MarineStationGMTOffset": 0,
      "VideoCode": "VideoCode",
      "LocationStem": "LocationStem",
      "DMA": {
        "ID": "ID",
        "EnglishName": "EnglishName"
      },
      "PartnerID": {},
      "Sources": [
        {
          "DataType": "DataType",
          "Source": "Source",
          "SourceId": 0,
          "PartnerSourceUrl": {}
        }
      ],
      "CanonicalPostalCode": "CanonicalPostalCode",
      "CanonicalLocationKey": "CanonicalLocationKey"
    },
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "AdministrativeArea": {
      "Level": 0,
      "LocalizedType": {},
      "EnglishType": {},
      "CountryID": "CountryID",
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    }
  }
]

json

application/json

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

countryCode

string

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

q

string · required

A string that indicates a postal code to search by.

Example: 07008

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

Postal code search by country code › Headers

Authorization

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

object[]

PrimaryPostalCode

string · minLength: 1 · required

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

object · required

IsAlias

boolean · required

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

object[] · 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)

object · required

object

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

curl --request GET \
  --url 'https://dataservice.accuweather.com/locations/v1/postalcodes/:countryCode/search?q=%3Cstring%3E' \
  --header 'Authorization: Bearer YOUR_API_KEY'

shell

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "TimeZone": {
      "Code": "Code",
      "NextOffsetChange": "2024-08-25T15:00:00Z",
      "Name": "Name",
      "GmtOffset": 0,
      "IsDaylightSaving": true
    },
    "GeoPosition": {
      "Elevation": {
        "Metric": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        },
        "Imperial": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        }
      },
      "Latitude": 0,
      "Longitude": 0
    },
    "IsAlias": true,
    "ParentCity": {
      "Key": "Key",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {
      "Key": "Key",
      "StationCode": "StationCode",
      "StationGmtOffset": 0,
      "BandMap": "BandMap",
      "Climo": "Climo",
      "LocalRadar": "LocalRadar",
      "MediaRegion": "MediaRegion",
      "Metar": "Metar",
      "NXMetro": "NXMetro",
      "NXState": "NXState",
      "Population": 0,
      "PrimaryWarningCountyCode": "PrimaryWarningCountyCode",
      "PrimaryWarningZoneCode": "PrimaryWarningZoneCode",
      "Satellite": "Satellite",
      "Synoptic": "Synoptic",
      "MarineStation": "MarineStation",
      "MarineStationGMTOffset": 0,
      "VideoCode": "VideoCode",
      "LocationStem": "LocationStem",
      "DMA": {
        "ID": "ID",
        "EnglishName": "EnglishName"
      },
      "PartnerID": {},
      "Sources": [
        {
          "DataType": "DataType",
          "Source": "Source",
          "SourceId": 0,
          "PartnerSourceUrl": {}
        }
      ],
      "CanonicalPostalCode": "CanonicalPostalCode",
      "CanonicalLocationKey": "CanonicalLocationKey"
    },
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "AdministrativeArea": {
      "Level": 0,
      "LocalizedType": {},
      "EnglishType": {},
      "CountryID": "CountryID",
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    }
  }
]

json

application/json

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

q

string · required

A string that indicates a postal code to search by.

Example: 07008

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

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

Postal code search › Headers

Authorization

string · required

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

Postal code search › Responses

object[]

PrimaryPostalCode

string · minLength: 1 · required

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

object · required

IsAlias

boolean · required

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

object[] · 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)

object · required

object

GET/locations/v1/postalcodes/search

curl --request GET \
  --url 'https://dataservice.accuweather.com/locations/v1/postalcodes/search?q=%3Cstring%3E' \
  --header 'Authorization: Bearer YOUR_API_KEY'

shell

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "TimeZone": {
      "Code": "Code",
      "NextOffsetChange": "2024-08-25T15:00:00Z",
      "Name": "Name",
      "GmtOffset": 0,
      "IsDaylightSaving": true
    },
    "GeoPosition": {
      "Elevation": {
        "Metric": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        },
        "Imperial": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        }
      },
      "Latitude": 0,
      "Longitude": 0
    },
    "IsAlias": true,
    "ParentCity": {
      "Key": "Key",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {
      "Key": "Key",
      "StationCode": "StationCode",
      "StationGmtOffset": 0,
      "BandMap": "BandMap",
      "Climo": "Climo",
      "LocalRadar": "LocalRadar",
      "MediaRegion": "MediaRegion",
      "Metar": "Metar",
      "NXMetro": "NXMetro",
      "NXState": "NXState",
      "Population": 0,
      "PrimaryWarningCountyCode": "PrimaryWarningCountyCode",
      "PrimaryWarningZoneCode": "PrimaryWarningZoneCode",
      "Satellite": "Satellite",
      "Synoptic": "Synoptic",
      "MarineStation": "MarineStation",
      "MarineStationGMTOffset": 0,
      "VideoCode": "VideoCode",
      "LocationStem": "LocationStem",
      "DMA": {
        "ID": "ID",
        "EnglishName": "EnglishName"
      },
      "PartnerID": {},
      "Sources": [
        {
          "DataType": "DataType",
          "Source": "Source",
          "SourceId": 0,
          "PartnerSourceUrl": {}
        }
      ],
      "CanonicalPostalCode": "CanonicalPostalCode",
      "CanonicalLocationKey": "CanonicalLocationKey"
    },
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "AdministrativeArea": {
      "Level": 0,
      "LocalizedType": {},
      "EnglishType": {},
      "CountryID": "CountryID",
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    }
  }
]

json

application/json

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

countryCode

string

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

Example: US

adminCode

string

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

q

string · required

A string that indicates a point of interest to search by.

Example: New York

type

string

A string that indicates the type of POIs to include.

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

allLanguages

boolean

A boolean value that specifies whether or not to search translated locations.

Default: false

Point of interest by country code and administrative code › Headers

Authorization

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

object[]

PrimaryPostalCode

string · minLength: 1 · required

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

object · required

IsAlias

boolean · required

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

object[] · 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)

object · required

object

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

curl --request GET \
  --url 'https://dataservice.accuweather.com/locations/v1/poi/:countryCode/:adminCode/search?q=%3Cstring%3E' \
  --header 'Authorization: Bearer YOUR_API_KEY'

shell

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "TimeZone": {
      "Code": "Code",
      "NextOffsetChange": "2024-08-25T15:00:00Z",
      "Name": "Name",
      "GmtOffset": 0,
      "IsDaylightSaving": true
    },
    "GeoPosition": {
      "Elevation": {
        "Metric": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        },
        "Imperial": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        }
      },
      "Latitude": 0,
      "Longitude": 0
    },
    "IsAlias": true,
    "ParentCity": {
      "Key": "Key",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {
      "Key": "Key",
      "StationCode": "StationCode",
      "StationGmtOffset": 0,
      "BandMap": "BandMap",
      "Climo": "Climo",
      "LocalRadar": "LocalRadar",
      "MediaRegion": "MediaRegion",
      "Metar": "Metar",
      "NXMetro": "NXMetro",
      "NXState": "NXState",
      "Population": 0,
      "PrimaryWarningCountyCode": "PrimaryWarningCountyCode",
      "PrimaryWarningZoneCode": "PrimaryWarningZoneCode",
      "Satellite": "Satellite",
      "Synoptic": "Synoptic",
      "MarineStation": "MarineStation",
      "MarineStationGMTOffset": 0,
      "VideoCode": "VideoCode",
      "LocationStem": "LocationStem",
      "DMA": {
        "ID": "ID",
        "EnglishName": "EnglishName"
      },
      "PartnerID": {},
      "Sources": [
        {
          "DataType": "DataType",
          "Source": "Source",
          "SourceId": 0,
          "PartnerSourceUrl": {}
        }
      ],
      "CanonicalPostalCode": "CanonicalPostalCode",
      "CanonicalLocationKey": "CanonicalLocationKey"
    },
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "AdministrativeArea": {
      "Level": 0,
      "LocalizedType": {},
      "EnglishType": {},
      "CountryID": "CountryID",
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    }
  }
]

json

application/json

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

countryCode

string

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

q

string · required

A string that indicates a point of interest to search by.

Example: New York

adminCode

string

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

Example: NY

type

string

A string that indicates the type of POIs to include.

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

allLanguages

boolean

A boolean value that specifies whether or not to search translated locations.

Default: false

Point of interest by country code › Headers

Authorization

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

object[]

PrimaryPostalCode

string · minLength: 1 · required

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

object · required

IsAlias

boolean · required

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

object[] · 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)

object · required

object

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

curl --request GET \
  --url 'https://dataservice.accuweather.com/locations/v1/poi/:countryCode/search?q=%3Cstring%3E' \
  --header 'Authorization: Bearer YOUR_API_KEY'

shell

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "TimeZone": {
      "Code": "Code",
      "NextOffsetChange": "2024-08-25T15:00:00Z",
      "Name": "Name",
      "GmtOffset": 0,
      "IsDaylightSaving": true
    },
    "GeoPosition": {
      "Elevation": {
        "Metric": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        },
        "Imperial": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        }
      },
      "Latitude": 0,
      "Longitude": 0
    },
    "IsAlias": true,
    "ParentCity": {
      "Key": "Key",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {
      "Key": "Key",
      "StationCode": "StationCode",
      "StationGmtOffset": 0,
      "BandMap": "BandMap",
      "Climo": "Climo",
      "LocalRadar": "LocalRadar",
      "MediaRegion": "MediaRegion",
      "Metar": "Metar",
      "NXMetro": "NXMetro",
      "NXState": "NXState",
      "Population": 0,
      "PrimaryWarningCountyCode": "PrimaryWarningCountyCode",
      "PrimaryWarningZoneCode": "PrimaryWarningZoneCode",
      "Satellite": "Satellite",
      "Synoptic": "Synoptic",
      "MarineStation": "MarineStation",
      "MarineStationGMTOffset": 0,
      "VideoCode": "VideoCode",
      "LocationStem": "LocationStem",
      "DMA": {
        "ID": "ID",
        "EnglishName": "EnglishName"
      },
      "PartnerID": {},
      "Sources": [
        {
          "DataType": "DataType",
          "Source": "Source",
          "SourceId": 0,
          "PartnerSourceUrl": {}
        }
      ],
      "CanonicalPostalCode": "CanonicalPostalCode",
      "CanonicalLocationKey": "CanonicalLocationKey"
    },
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "AdministrativeArea": {
      "Level": 0,
      "LocalizedType": {},
      "EnglishType": {},
      "CountryID": "CountryID",
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    }
  }
]

json

application/json

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

q

string · required

A string that indicates a point of interest to search by.

Example: New York

countryCode

string

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

Example: US

adminCode

string

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

Example: NY

type

string

A string that indicates the type of POIs to include.

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

allLanguages

boolean

A boolean value that specifies whether or not to search translated locations.

Default: false

Point of interest search › Headers

Authorization

string · required

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

Point of interest search › Responses

object[]

PrimaryPostalCode

string · minLength: 1 · required

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

object · required

IsAlias

boolean · required

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

object[] · 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)

object · required

object

GET/locations/v1/poi/search

curl --request GET \
  --url 'https://dataservice.accuweather.com/locations/v1/poi/search?q=%3Cstring%3E' \
  --header 'Authorization: Bearer YOUR_API_KEY'

shell

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "TimeZone": {
      "Code": "Code",
      "NextOffsetChange": "2024-08-25T15:00:00Z",
      "Name": "Name",
      "GmtOffset": 0,
      "IsDaylightSaving": true
    },
    "GeoPosition": {
      "Elevation": {
        "Metric": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        },
        "Imperial": {
          "UnitType": 0,
          "Value": 0,
          "Unit": "Unit"
        }
      },
      "Latitude": 0,
      "Longitude": 0
    },
    "IsAlias": true,
    "ParentCity": {
      "Key": "Key",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {
      "Key": "Key",
      "StationCode": "StationCode",
      "StationGmtOffset": 0,
      "BandMap": "BandMap",
      "Climo": "Climo",
      "LocalRadar": "LocalRadar",
      "MediaRegion": "MediaRegion",
      "Metar": "Metar",
      "NXMetro": "NXMetro",
      "NXState": "NXState",
      "Population": 0,
      "PrimaryWarningCountyCode": "PrimaryWarningCountyCode",
      "PrimaryWarningZoneCode": "PrimaryWarningZoneCode",
      "Satellite": "Satellite",
      "Synoptic": "Synoptic",
      "MarineStation": "MarineStation",
      "MarineStationGMTOffset": 0,
      "VideoCode": "VideoCode",
      "LocationStem": "LocationStem",
      "DMA": {
        "ID": "ID",
        "EnglishName": "EnglishName"
      },
      "PartnerID": {},
      "Sources": [
        {
          "DataType": "DataType",
          "Source": "Source",
          "SourceId": 0,
          "PartnerSourceUrl": {}
        }
      ],
      "CanonicalPostalCode": "CanonicalPostalCode",
      "CanonicalLocationKey": "CanonicalLocationKey"
    },
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    },
    "AdministrativeArea": {
      "Level": 0,
      "LocalizedType": {},
      "EnglishType": {},
      "CountryID": "CountryID",
      "ID": "ID",
      "LocalizedName": "LocalizedName",
      "EnglishName": "EnglishName"
    }
  }
]

json

application/json

Region search

GET

https://dataservice.accuweather.com

/locations/v1/regions/{regionCode}

Returns data about a specific region

Region search › path Parameters

regionCode

string

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

Example: NAM

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

Region search › Headers

Authorization

string · required

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

Region search › Responses

object[]

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

GET/locations/v1/regions/{regionCode}

curl --request GET \
  --url https://dataservice.accuweather.com/locations/v1/regions/:regionCode \
  --header 'Authorization: Bearer YOUR_API_KEY'

shell

Example Responses

[
  {
    "ID": "ID",
    "LocalizedName": "LocalizedName",
    "EnglishName": "EnglishName"
  }
]

json

application/json

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

countryCode

string

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

q

string

A string that indicates a free-form query to search.

Example: New York

adminCode

string

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

Example: NY

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

Administrative area search by country code and text string › Headers

Authorization

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

object[]

Level

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

CountryID

string · minLength: 1 · required

Unique ISO or Microsoft Localization Code for the country that contains the AdministrativeArea.

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

LocalizedType

string | null

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

EnglishType

string | null

Administrative Area type displayed in English.

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

curl --request GET \
  --url https://dataservice.accuweather.com/locations/v1/adminareas/:countryCode/search \
  --header 'Authorization: Bearer YOUR_API_KEY'

shell

Example Responses

[
  {
    "Level": 0,
    "LocalizedType": {},
    "EnglishType": {},
    "CountryID": "CountryID",
    "ID": "ID",
    "LocalizedName": "LocalizedName",
    "EnglishName": "EnglishName"
  }
]

json

application/json

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

q

string

A string that indicates a free-form query to search.

Example: New York

countryCode

string

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

Example: US

adminCode

string

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

Example: NY

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

Administrative area search by text string › Headers

Authorization

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

object[]

Level

integer · int64 · required

CountryID

string · minLength: 1 · required

Unique ISO or Microsoft Localization Code for the country that contains the AdministrativeArea.

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

LocalizedType

string | null

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

EnglishType

string | null

Administrative Area type displayed in English.

GET/locations/v1/adminareas/search

curl --request GET \
  --url https://dataservice.accuweather.com/locations/v1/adminareas/search \
  --header 'Authorization: Bearer YOUR_API_KEY'

shell

Example Responses

[
  {
    "Level": 0,
    "LocalizedType": {},
    "EnglishType": {},
    "CountryID": "CountryID",
    "ID": "ID",
    "LocalizedName": "LocalizedName",
    "EnglishName": "EnglishName"
  }
]

json

application/json

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

adminCode

string

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

Example: NY

countryCode

string

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

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

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

Authorization

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

Level

integer · int64 · required

CountryID

string · minLength: 1 · required

Unique ISO or Microsoft Localization Code for the country that contains the AdministrativeArea.

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

LocalizedType

string | null

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

EnglishType

string | null

Administrative Area type displayed in English.

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

curl --request GET \
  --url https://dataservice.accuweather.com/locations/v1/adminareas/:countryCode/:adminCode \
  --header 'Authorization: Bearer YOUR_API_KEY'

shell

Example Responses

{
  "Level": 0,
  "LocalizedType": {},
  "EnglishType": {},
  "CountryID": "CountryID",
  "ID": "ID",
  "LocalizedName": "LocalizedName",
  "EnglishName": "EnglishName"
}

json

application/json

Autocomplete Geoposition